Sign in
latestOpenAPI 3.0.02026-08-1284111344.5 KB

14666f4db0f8

Client Notes

Update a Client Note

Updates the content and/or pinned state of a note belonging to the given client.

put/v2/clients/{clientId}/notes/{noteId}

Path parameters

clientIdstring required
Example:CL-OvmDp2yvv1yqMwRl

The client ID (prefix CL-).

noteIdstring required
Example:CLN-211d1676f4b90c40

The client note ID (prefix CLN-).

Headers

Authorizationstring required
Example:Bearer <token>

Bearer Token

Request body

notestring

The note content.

pinboolean

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

Example request

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

Response

The updated 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"
}