Comments

Collaborate on builds with threaded comments: post and edit comments, react with emojis, resolve threads, and manage notification subscriptions.

List the comments on a build

get

List the comments on a build, with pagination.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

Responses

200

Build comments, oldest first. Replies carry a threadId pointing at their root comment.

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}/builds/{buildNumber}/comments

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project}/builds/{buildNumber}/comments HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "buildId": "text",
    "threadId": "text",
    "body": null,
    "text": "text",
    "author": {
      "id": "text",
      "slug": "text",
      "name": "text"
    },
    "screenshotDiffId": "text",
    "anchor": {
      "type": "text",
      "x": 1,
      "y": 1
    },
    "pending": true,
    "resolvedAt": "text",
    "editedAt": "text",
    "createdAt": "text",
    "reactions": [
      {
        "emoji": "text",
        "count": 1,
        "users": [
          {
            "id": "text",
            "slug": "text",
            "name": "text"
          }
        ]
      }
    ]
  }
]

Post a comment (or reply) on a build

post

Post a comment on a build. Start a new thread, reply to an existing one with threadId, optionally anchor the comment to a screenshot diff, or attach it to your pending review with addToReview.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

Body

application/json

bodyany ofRequired

Comment content. Either Markdown text or the JSON representation of a rich-text document.

stringOptional

or

threadIdstringOptional

Root comment ID to reply to.

screenshotDiffIdstringOptional

Screenshot diff to anchor the comment to. Required when anchor is set.

anchorone ofOptional

Where on the referenced screenshot diff the comment points. A point uses normalized (0–1) coordinates; lines is a 1-based inclusive range.

or

addToReviewbooleanOptional

Attach the comment to your pending review (created if needed) instead of posting it immediately. Ignored for replies, which inherit their thread's review.

Responses

201

Comment created successfully — returns the comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/builds/{buildNumber}/comments

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/builds/{buildNumber}/comments HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 115

{
  "body": "text",
  "threadId": "text",
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "addToReview": true
}

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Get a single comment on a build

get

Retrieve a single comment on a build by its ID.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

The ID of the comment

Responses

200

Comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

get/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}

HTTPcURLJavaScriptPython

GET /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Delete a comment on a build

delete

Delete a comment on a build. Only the comment's author can delete it.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

The ID of the comment

Responses

200

Comment deleted successfully — returns the comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

delete/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}

HTTPcURLJavaScriptPython

DELETE /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Update a comment on a build

patch

Update the body of a comment on a build. Only the comment's author can edit it.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

The ID of the comment

Body

application/json

bodyany ofRequired

Comment content. Either Markdown text or the JSON representation of a rich-text document.

stringOptional

or

Responses

200

Comment updated successfully — returns the comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

patch/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}

HTTPcURLJavaScriptPython

PATCH /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId} HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "body": "text"
}

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Add an emoji reaction to a comment

post

Add an emoji reaction to a comment on behalf of the authenticated user.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

The ID of the comment

Body

application/json

emojistringRequired

The emoji to react with.

Responses

200

Reaction added — returns the comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/reactions

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/reactions HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "emoji": "text"
}

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Remove an emoji reaction from a comment

delete

Remove an emoji reaction previously added by the authenticated user from a comment.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

The ID of the comment

Query parameters

emojistringRequired

The emoji reaction to remove.

Responses

200

Reaction removed — returns the comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

delete/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/reactions

HTTPcURLJavaScriptPython

DELETE /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/reactions?emoji=text HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Mark a comment thread as resolved

post

Mark a comment thread as resolved.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

ID of any comment in the thread

Responses

200

Thread resolved — returns the root comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/resolve

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/resolve HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Reopen a resolved comment thread

post

Reopen a previously resolved comment thread.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

ID of any comment in the thread

Responses

200

Thread reopened — returns the root comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/unresolve

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/unresolve HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Subscribe to a comment thread's notifications

post

Subscribe the authenticated user to a comment thread to receive notifications about new replies.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

ID of any comment in the thread

Responses

200

Subscribed — returns the root comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

post/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/subscription

HTTPcURLJavaScriptPython

POST /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/subscription HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}

Unsubscribe from a comment thread's notifications

delete

Unsubscribe the authenticated user from a comment thread's notifications.

Authorizations

personalAccessToken

AuthorizationstringRequired

Authenticate as a user with a personal access token.

Send it as a bearer token in the Authorization header:

Authorization: Bearer <personal-access-token>

Personal access tokens act on behalf of the user that created them and are required by endpoints that perform user actions, such as reviewing builds and posting comments.

Path parameters

ownerstring · min: 1Required

projectstring · min: 1Required

buildNumberstringRequired

The build number

Example: 42

commentIdstringRequired

ID of any comment in the thread

Responses

200

Unsubscribed — returns the root comment

application/json

A comment posted on a build.

idstringRequired

buildIdstringRequired

threadIdstring · nullableRequired

Root comment ID when this comment is a reply.

bodyanyRequired

Rich-text JSON content of the comment.

textstringRequired

Plain-text rendering of the comment content.

screenshotDiffIdstring · nullableRequired

Screenshot diff this comment is anchored to, if any.

anchorone of · nullableRequired

Where the comment points on its screenshot diff. Null means the whole diff.

or

pendingbooleanRequired

Whether the comment belongs to a pending (unsubmitted) review and is only visible to its author.

resolvedAtstring · nullableRequired

Date the thread was resolved, null if not resolved. Only set on a root comment.

editedAtstring · nullableRequired

Date the comment was last edited, null if never edited.

createdAtstringRequired

Date the comment was posted.

400

Invalid parameters

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Server error

application/json

delete/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/subscription

HTTPcURLJavaScriptPython

DELETE /v2/projects/{owner}/{project}/builds/{buildNumber}/comments/{commentId}/subscription HTTP/1.1
Host: api.argos-ci.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "buildId": "text",
  "threadId": "text",
  "body": null,
  "text": "text",
  "author": {
    "id": "text",
    "slug": "text",
    "name": "text"
  },
  "screenshotDiffId": "text",
  "anchor": {
    "type": "text",
    "x": 1,
    "y": 1
  },
  "pending": true,
  "resolvedAt": "text",
  "editedAt": "text",
  "createdAt": "text",
  "reactions": [
    {
      "emoji": "text",
      "count": 1,
      "users": [
        {
          "id": "text",
          "slug": "text",
          "name": "text"
        }
      ]
    }
  ]
}