Case notes
List the notes of a case
Newest first.
Required scope: cases:read.
path Parameters
id^cse_[0-9A-Za-z]{22}… · requiredThe id of the case (cse_…).
query Parameters
limitcursorThe nextCursor of the previous page, with the same filters.
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
List the notes of a case › Responses
Add a note to a case
Internal: only the team sees it. It is signed with authorName when you send it (the person who writes), otherwise with the author name of the API key, or its name.
Required scope: cases:write.
path Parameters
id^cse_[0-9A-Za-z]{22}… · requiredThe id of the case (cse_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Idempotency-KeyMakes the request safe to retry. Once it starts running, its final response (2xx, 4xx or 5xx) is kept for 24 hours and the same key gets it back, without repeating the effect. A request rejected before it runs leaves the key free. A replayed create omits the secret. The same key with a different request is rejected with 409 idempotency_key_reused.
Add a note to a case › Request Body
contentauthorNameThe person who writes the note, shown as its author. Omit it to sign with the name of the API key.
Add a note to a case › Responses
objectidcaseIdcontentauthorWho wrote it: authorName, a member, or the name of the API key.
pinnedtrue for the pinned note of the case, shown first.
createdAtupdatedAtRetrieve a note
Returns one internal note of a case by id. Use it to refresh a single record you already know; to find records, use the list route. Read only. 404 not_found when the id does not exist or belongs to another organization. You can repeat it safely: it has no side effects.
Required scope: cases:read.
path Parameters
id^cse_[0-9A-Za-z]{22}… · requiredThe id of the case (cse_…).
noteId^not_[0-9A-Za-z]{22}… · requiredThe id of the note (not_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Retrieve a note › Responses
objectidcaseIdcontentauthorWho wrote it: authorName, a member, or the name of the API key.
pinnedtrue for the pinned note of the case, shown first.
createdAtupdatedAtDelete a note
Deletes an internal note of a case. The effect is permanent through the API. Repeating the call returns 404 not_found, because the note no longer exists, so do not retry a 404 as a failure.
Required scope: cases:write.
path Parameters
id^cse_[0-9A-Za-z]{22}… · requiredThe id of the case (cse_…).
noteId^not_[0-9A-Za-z]{22}… · requiredThe id of the note (not_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Delete a note › Responses
Edit a note
Edits the text of an internal note. The contact never sees notes. Applying the same body twice leaves the same result.
Required scope: cases:write.
path Parameters
id^cse_[0-9A-Za-z]{22}… · requiredThe id of the case (cse_…).
noteId^not_[0-9A-Za-z]{22}… · requiredThe id of the note (not_…).
Headers
Lelemon-Subaccount^sub_[0-9A-Za-z]{22}…The subaccount (sub_…) this request acts on. Only for the keys of a platform account; without it the request acts on the account itself.
Edit a note › Request Body optional
contentpinnedtrue pins the note and unpins the one that was pinned: a case has one pinned note. false unpins it. Send content, pinned or both.
Edit a note › Responses
objectidcaseIdcontentauthorWho wrote it: authorName, a member, or the name of the API key.
pinnedtrue for the pinned note of the case, shown first.
createdAtupdatedAt