Models
API Request Objects
Models
API Request Objects
Comments
Threads
AddCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotation | CommentAnnotation | Yes | Comment annotation |
options | RequestOptions | No | Request options |
DeleteCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Messages
AddCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
comment | Comment | Yes | Comment object |
assignedTo | User | No | Assigned user |
options | RequestOptions | No | Request options |
UpdateCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
comment | Comment | Yes | Comment object |
merge | boolean | No | Merge comments |
options | RequestOptions | No | Request options |
DeleteCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
skipDeleteThreadConfirmation | boolean | No | Skip delete confirmation |
options | RequestOptions | No | Request options |
GetCommentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
@Mentions
AssignUserRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
assignedTo | UserContact | Yes | User to assign |
options | RequestOptions | No | Request options |
SubscribeCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
UnsubscribeCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Attachments
AddAttachmentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
files | File[] | Yes | Array of files |
options | RequestOptions | No | Request options |
DeleteAttachmentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
attachmentId | number | Yes | ID of the attachment |
options | RequestOptions | No | Request options |
GetAttachmentRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
options | RequestOptions | No | Request options |
AddAttachmentResponse
| Property | Type | Required | Description |
|---|---|---|---|
valid | boolean | Yes | Validity status |
file | File | No | File object |
maxAllowedSize | number | Yes | Max allowed size |
error | string | No | Error message |
attachment | Attachment | No | Attachment object |
Reactions
AddReactionRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
DeleteReactionRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
ToggleReactionRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
reaction | { reactionId: string; customReaction?: ReactionItem; } | Yes | Reaction object with reactionId and optional customReaction |
options | RequestOptions | No | Request options |
ReactionItem
| Property | Type | Required | Description |
|---|---|---|---|
url | string | No | URL of the reaction image |
svg | string | No | SVG markup of the reaction |
emoji | string | No | Emoji character |
Status & Priority
UpdateStatusRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
status | CustomStatus | Yes | Status value |
options | RequestOptions | No | Request options |
ResolveCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
UpdatePriorityRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
priority | CustomPriority | No | Priority object |
options | RequestOptions | No | Request options |
ApproveCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
AcceptCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
RejectCommentAnnotationRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Recordings
GetRecordingRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
options | RequestOptions | No | Request options |
DeleteRecordingRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
commentId | number | Yes | ID of the comment |
recorderId | string | Yes | ID of the recorder |
options | RequestOptions | No | Request options |
Deep Links
GetLinkRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
CopyLinkRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
options | RequestOptions | No | Request options |
Access
UpdateAccessRequest
| Property | Type | Required | Description |
|---|---|---|---|
annotationId | string | Yes | ID of the annotation |
accessMode | CommentAccessMode | Yes | Access mode |
options | RequestOptions | No | Request options |
RequestOptions
| Property | Type | Required | Description |
|---|---|---|---|
organizationId | string | No | Organization ID |
documentId | string | No | Document ID |
Was this page helpful?