Sign in

v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Messages

Update Conversation Note

Set or clear the host's private note attached to a conversation thread. The note is stored only in Hostex (visible in the Hostex Inbox), is never sent to the guest or pushed to any channel, and is shared across operators inside the same account. Pass an empty string or null in note to clear the existing note.

patch/conversations/{conversation_id}/note

Path parameters

conversation_idstring required

The id of the conversation.

Request body

notestring nullable required

The host-side private note. Pass an empty string or null to clear the existing note. Max 5000 characters.

Response

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}