The Comment Attachment object represents files with the status uploaded that have been attached to a Comment.
Comments can currently support up to 3 attachments.
Request Format (Input)
Object properties
The input to Comment APIs like Create comment contains attachments with the following fields:
| Field | Type | Description | Example value |
|---|---|---|---|
file_upload_id | string (enum) | ID of a File Upload with status "uploaded" | "12345678-1234-1234-1234-123456789012" |
type | string(optional) | Possible type values are:"file_upload" | "file_upload" |
{
"file_upload_id": "12345678-1234-1234-1234-123456789012"
}
Response Format (Output)
Object properties
The response of Comment APIs like Create comment contains attachments with the following fields:
| Field | Type | Description | Example value |
|---|---|---|---|
category | string (enum) | The category of this attachment. Possible type values are: "audio", "image", "pdf", productivity, and video | "audio" |
file | object | A file object containing type-specific configuration. | { "url": "<https://s3.us-west-2.amazonaws.com/...">, "expiry_time": "2025-06-10T21:26:03.070Z" } |
{
"category": "video",
"file": {
"url": "https://s3.us-west-2.amazonaws.com/...",
"expiry_time": "2025-06-10T21:26:03.070Z"
}
}