v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create Note

This API endpoint creates a note on a specified client or company in your workspace.

post/v1/notes

Request body

entityTypestring required

The type of entity that this note is associated with. Can be one of client or company.

entityIdstring required

The ID of the entity (client or company) that this note is associated with.

titlestring required

The note’s title. This field does not support formatting or newlines.

contentstring

The note’s content. This must be valid HTML.

Response

200

contentstring

createdAtstring

creatorIdstring

entityIdstring

entityTypestring

idstring

objectstring

titlestring

updatedAtstring

Example response

{
  "content": "<p>Example content.</p>",
  "createdAt": "2025-03-12T16:11:26Z",
  "creatorId": "2417c06f-44fe-4913-8c84-cd5d358d6f4b",
  "entityId": "9edc4eb8-2b52-454a-bacf-c1d3889a1fbd",
  "entityType": "company",
  "id": "8c9508c6-ccbb-4f94-939e-5c1c1b0302cb",
  "object": "note",
  "title": "Example Note"
}