Sign in

v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB
Case

Create a note on a case

Create a new note on the case of the given ID. Notes are an internal, agent-facing annotation on a Case and never appear in any customer-facing webhook or response.

post/contact_cases/{id}/notes

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The ID of the case. The ID is returned from GET /v1.0/contact_cases response.

Request body

author_type'agent' | 'system' required

Type of the note's author.

author_idstring uuid

ID of the agent authoring this note. Nullable for system-authored notes.

textstring required

The note's text content.

Example request

{
  "author_type": "agent",
  "author_id": "2a2ec0ba-8004-11ec-aea5-439829c92a7c",
  "text": "Called the customer back, no answer."
}

Response

Case note created successfully.

idstring uuid

Unique identifier for the case note.

customer_idstring uuid

Unique identifier of the associated customer.

case_idstring uuid

The case this note belongs to. The ID is returned from GET /v1.0/contact_cases response.

author_type'agent' | 'system'

Type of the note's author.

author_idstring uuid

ID of the agent authoring this note. Nullable for system-authored notes.

textstring

The note's text content.

tm_createstring date-time

Timestamp when this note was created.

tm_updatestring date-time

Timestamp when this note was last updated.

tm_deletestring date-time

Timestamp when this note was soft-deleted. Null if active.

Example response

{
  "id": "33333333-0000-0000-0000-000000000003",
  "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
  "case_id": "550e8400-e29b-41d4-a716-446655440000",
  "author_type": "agent",
  "author_id": "2a2ec0ba-8004-11ec-aea5-439829c92a7c",
  "text": "Called the customer back, no answer.",
  "tm_create": "2026-06-01T09:30:00.000000Z",
  "tm_update": "2026-06-01T09:30:00.000000Z",
  "tm_delete": "2026-06-02T08:00:00.000000Z"
}