Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Client Notes

Create a new Client Note

Creates a new note for the given client.

post/v2/clients/{clientId}/notes

Path parameters

clientIdstring required
Example:CL-OvmDp2yvv1yqMwRl

The client ID (prefix CL-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

notestring required

The note content.

pinboolean

Whether the note is pinned to the top of the list.

Example request

{
  "note": "Customer requested a follow-up call."
}

Response

The created client note.

idstring

The ID of the client note (prefix CLN-).

notestring

The note content.

pinboolean

Whether the note is pinned to the top of the list.

techNamestring

The name of the user who created the note.

createdAtstring

The date and time the note was created.

Example response

{
  "id": "CLN-211d1676f4b90c40",
  "note": "Customer requested a follow-up call.",
  "techName": "John Doe",
  "createdAt": "2021-01-01 00:00:00"
}