Assign a comment (action item)

PATCH

/v1/data/{artifactId}/comments/{commentId}/assign

curl --request PATCH \
  --url https://shareout.site/v1/data/example/comments/example/assign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "assignee": "example", "dueAt": "2026-04-15T12:00:00Z" }'

• Production

Turns a thread into an action item for a workspace member or collaborator, or clears it with assignee: null (also clears dueAt). Same callers as resolve. The assignee is notified.

Authorizations

• bearerAuth

Parameters

Path Parameters

artifactId

required

string

Artifact ID (e.g. art_abc123).

commentId

required

string

Request Body^required

Media typeapplication/json

object

assignee

Email of a workspace member or collaborator.

string | null

dueAt

string | null format: date-time

Example^generated

{
  "assignee": "example",
  "dueAt": "2026-04-15T12:00:00Z"
}

Responses

200

The updated comment

Media typeapplication/json

object

success

boolean

data

object

id

cmt_ + 24 hex characters.

string

contextId

string | null

parentId

string | null

authorId

string | null

authorName

string

content

string

createdAt

string format: date-time

updatedAt

string format: date-time

resolved

boolean

resolvedBy

string | null

resolvedAt

string | null format: date-time

position

Pin position on the page, when the comment was placed as a pin.

mentions

Array<string>

authorType

guest = a verified guest with no account (their email is never returned).

string

Allowed values: human agent guest

assigneeUserId

string | null

assigneeEmail

string | null

dueAt

string | null format: date-time

versionId

Id of the version that was live when the comment was written; null on older comments.

string | null

reactions

object

key

additional properties

object

count

integer

mine

boolean

Example

{
  "data": {
    "authorType": "human"
  }
}

400

ASSIGNEE_NOT_FOUND — not a workspace member or collaborator; INVALID_REQUEST for a bad dueAt

403

FORBIDDEN (no comment access) or COMMENTS_DISABLED

404

COMMENT_NOT_FOUND