Create a comment
Creates a new comment related to an existing thread, record or entry.
To create comments on records, you will need the object_configuration:read and record_permission:read scopes.
To create comments on list entries, you will need the list_configuration:read and list_entry:read scopes.
Required scopes: comment:read-write.
curl --request POST \
--url https://api.attio.com/v2/comments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"format": "plaintext",
"content": "If I put the email address of my colleague on Attio in here, e.g. alice@attio.com, they will be notified. Other emails (e.g. person@example.com) will be turned into clickable links.",
"author": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2023-01-01T15:00:00.000000000Z",
"thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
}
}'{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
},
"thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
"content_plaintext": "Let's go ahead and close this deal, alice@attio.com.",
"entry": {
"entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
"list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
},
"record": {
"record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
},
"resolved_at": "2023-01-01T15:00:00.000000000Z",
"resolved_by": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2023-01-01T15:00:00.000000000Z",
"author": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
}
}Authorizations
This API uses OAuth 2.0 with the authorization code grant flow.
Body
The format that the comment content is provided in. The plaintext format uses the line feed character \n to create new lines within the note content. Rich text formatting and links are not supported.
plaintext The content of the comment itself. Workspace members can be mentioned using their email address, otherwise email addresses will be presented to users as clickable mailto links.
"If I put the email address of my colleague on Attio in here, e.g. alice@attio.com, they will be notified. Other emails (e.g. person@example.com) will be turned into clickable links."
If responding to an existing thread, this would be the ID of that thread.
"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
created_at will default to the current time. However, if you wish to backdate a comment for migration or other purposes, you can override with a custom created_at value. Note that dates before 1970 or in the future are not allowed.
"2023-01-01T15:00:00.000000000Z"
Response
Success
The ID of the thread the comment belongs to.
"aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
A plaintext representation of the content of the comment. References to workspace members are cast into email addresses, all other stylistic elements are removed.
"Let's go ahead and close this deal, alice@attio.com."
The entry the comment belongs to, null for comments on records.
Whether the comment is resolved.
"2023-01-01T15:00:00.000000000Z"
The actor that resolved this comment.
An ID to identify the actor.
The type of actor. Read more information on actor types here.
api-token, workspace-member, system, app {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
When the note was created.
"2023-01-01T15:00:00.000000000Z"
Who wrote this comment. Note that the API provides the ability for API tokens to write comments on behalf of other actors.
An ID to identify the actor.
The type of actor. Read more information on actor types here.
api-token, workspace-member, system, app {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
Was this page helpful?
curl --request POST \
--url https://api.attio.com/v2/comments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": {
"format": "plaintext",
"content": "If I put the email address of my colleague on Attio in here, e.g. alice@attio.com, they will be notified. Other emails (e.g. person@example.com) will be turned into clickable links.",
"author": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2023-01-01T15:00:00.000000000Z",
"thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
}
}'{
"data": {
"id": {
"workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
"comment_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2"
},
"thread_id": "aa1dc1d9-93ac-4c6c-987e-16b6eea9aab2",
"content_plaintext": "Let's go ahead and close this deal, alice@attio.com.",
"entry": {
"entry_id": "2e6e29ea-c4e0-4f44-842d-78a891f8c156",
"list_id": "33ebdbe9-e529-47c9-b894-0ba25e9c15c0"
},
"record": {
"record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
"object_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
},
"resolved_at": "2023-01-01T15:00:00.000000000Z",
"resolved_by": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
},
"created_at": "2023-01-01T15:00:00.000000000Z",
"author": {
"type": "workspace-member",
"id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b"
}
}
}