Comments

Comments on tasks, deals, companies, persons, pages, projects, purchase orders, and invoices. Supports rich text with @mentions, emoji reactions, pinning, and edit history. Comments appear in the activity feed of the parent resource.

Attributes

attachment_ids object
Request

IDs of attachments to add to this comment when creating or updating.

attachments array of attachment
Response

File attachments included in this comment.

body string
Response Request

The HTML body of the comment including rich text formatting and @mention markup.

budget_status integer
Parameter `filter`

The budget status context when this comment was posted (for deal-related comments).

commentable_project_id integer
Parameter `filter`

ID of the project this comment belongs to, derived from the commentable resource.

commentable_type string
Response

The type of the parent entity this comment is posted on (e.g. task, deal, company).

company company
Response

The company this comment is associated with, if posted on a company's activity feed.

company_id integer
Request Parameter `filter`

The ID of the company this comment is associated with.

created_at string
Response Parameter `sort`

Timestamp when this comment was created.

creator person
Response

The person who created this comment.

deal deal
Response

The deal this comment is associated with, if posted on a deal's activity feed.

deal_id integer
Request

The ID of the deal this comment is associated with.

deleted_at string
Response

Timestamp when this comment was soft-deleted. Null if not deleted.

discussion discussion
Response

The discussion thread this comment belongs to, if posted in a doc discussion.

discussion_id integer
Request Parameter `filter`

The ID of the discussion thread this comment belongs to.

draft boolean
Response Request Parameter `filter`

Whether this comment is a draft (not yet published and not visible to others).

edited_at string
Response

Timestamp when this comment was last edited.

full_query string
Parameter `filter`

Full-text search query context for this comment.

fuzzy_dates string
Parameter `filter`

Fuzzy date tokens extracted from this comment for search purposes.

fuzzy_people integer
Parameter `filter`

Fuzzy person references extracted from this comment for search purposes.

hidden boolean
Response Request

Whether this comment is hidden from the activity feed (moderated or removed).

invoice invoice
Response

The invoice associated with this comment, if the comment is on an invoice.

invoice_id integer
Request

The ID of the invoice this comment belongs to, if applicable.

jump_query string
Parameter `filter`

A query string used to deep-link to the specific comment location in the UI.

organization organization
Response

The organization this comment belongs to.

page_id integer
Parameter `filter`

The ID of the page this comment belongs to, if applicable.

person person
Response

The person who authored this comment.

person_id integer
Request

The ID of the person who authored this comment.

person_type integer
Parameter `filter`

The type of person who authored this comment (e.g. member, client).

pinned_at string
Response

Timestamp when this comment was pinned, or null if not pinned.

pinned_by person
Response

The person who pinned this comment.

project project
Response

The project this comment belongs to, derived from the commentable resource.

project_id integer
Request Parameter `filter`

The ID of the project this comment belongs to, if applicable.

proposal_id integer
Request

The ID of the proposal this comment belongs to, if applicable.

public_access boolean
Parameter `filter`

Indicates whether this comment is publicly accessible without authentication.

purchase_order purchase order
Response

The purchase order this comment belongs to, if applicable.

purchase_order_id integer
Request

The ID of the purchase order this comment belongs to, if applicable.

reactions object
Response

Emoji reactions on this comment, keyed by emoji with people and timestamps.

resource_request_id integer
Request

The ID of the resource request this comment belongs to, if applicable.

responsible_id integer
Parameter `filter`

The ID of the project manager (responsible person) in an activity comment context.

role_id integer
Parameter `filter`

The ID of the role referenced in this comment's activity context.

sales_status_id integer
Parameter `filter`

The ID of the sales status referenced in this comment's activity context.

status integer
Parameter `filter`

The status label referenced in this comment's activity context.

status_id integer
Parameter `filter`

The ID of the workflow status referenced in this comment's activity context.

task task
Response

The task this comment belongs to, if applicable.

task_id integer
Request Parameter `filter`

The ID of the task this comment belongs to, if applicable.

updated_at string
Response

Timestamp when this comment was last updated.

version_number integer
Response Request

The version number of this comment, incremented on each edit.

workflow_status_category_id string
Parameter `filter`

The ID of the workflow status category referenced in this comment's activity context.