Skip to content
Docs

Add Thread Note

Add an internal note to a thread.

POST/api/v1/inbox/threads/{reply_id}/notes

Requires an API key with the write scope.

The note is credited to the user who owns the API key, so its author shows that person's name. It is never sent to the lead. The call writes an audit.inbox_note.created entry in the event log that records the key, not the note text.

Path Parameters#

reply_idstringpathrequired

The unique identifier of the thread (reply).

Body Parameters#

contentstringbodyrequired

The note text. Up to 200,000 characters; leading and trailing spaces are trimmed.

Response#

Returns the created note in data.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: write
404Thread not found in this workspace
422Empty or blank content

Rate Limit#

  • 120 requests per minute, shared by every write call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (write).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 4, 2026