Comments

Comments let you add notes and context to any record. They support plain text and are visible to everyone with access to the record.

Create a comment

POST /comments

{
  "body": "Follow up in two weeks — evaluating three vendors.",
  "record_id": "per_01HX9Z2K3M4N5P6Q7R8S9T0U",
  "record_type": "person"
}

record_type is the object type the comment belongs to: person, company, deal, meeting, or a custom object slug.

Returns the created comment with its id, body, record_id, record_type, author, and created_at.

{
  "id": "cmt_01HX9Z2K3M4N5P6Q7R8S9T0X",
  "body": "Follow up in two weeks — evaluating three vendors.",
  "record_id": "per_01HX9Z2K3M4N5P6Q7R8S9T0U",
  "record_type": "person",
  "author": {
    "id": "usr_01HX9Z2K3M4N5P6Q7R8S9T0Y",
    "name": "Taylor Reeves"
  },
  "created_at": "2024-03-15T14:32:00Z"
}

Update a comment

PATCH /comments/{id}

Only body can be updated. Authorship and timestamp are preserved as-is.

{
  "body": "Budget confirmed — closing next week."
}

Returns the updated comment.

Delete a comment

DELETE /comments/{id}

Permanently deletes the comment. Returns 204 No Content with no response body.