Create a note

Required scope: notes:write.

Adds a note to a client, attributed to your integration. Send content as plain_text (the default), markdown or serialized Tiptap JSON (tiptap), with an optional title.

Chronicle converts the content to rich text, keeping supported formatting and removing unsafe attributes and links. HTML is treated as text and never executed. The request body and the converted note are each limited to 256 KiB; larger content is rejected, never truncated.

Requires an Idempotency-Key. Retrying with the same key and body within 24 hours returns the original result without repeating the action. Note titles and content are never included in webhook events.

POST /api/v2/clients/{id}/notes
Bearer token scope notes:write

Path parameters

· 1
id string required

Client ID.

Headers

· 1
Idempotency-Key string · min length: 1· max length: 128 · pattern required

Unique key for this operation, 1 to 128 visible ASCII characters (for example a UUID). Reuse it only when retrying the same request.

Body

required application/json
title string | null · default: null
content string · min length: 1 required
format string · default: plain_text· enum

values

  • plain_text
  • markdown
  • tiptap

Responses