threads

Label a conversation

Adds and removes labels on every message currently in the conversation, received and sent, leaving their other labels as they are. The label rules apply. Messages that arrive later don't get the labels.

The counts cover every message updated, including those that already matched, and add_labels and remove_labels echo the change rather than each message's labels.

patch/v1/threads/{thread_id}

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/threads/{thread_id}
  • Auth: HTTP bearer

Path parameters

thread_idstring required

Cherami resource ID returned by the API.

Request body

add_labelsLabel[]

Label names, case-sensitive; order and duplicates don't matter.

remove_labelsLabel[]

Label names, case-sensitive; order and duplicates don't matter.

Response

Success.

idstring required

Cherami resource ID.

inbox_idstring required

Cherami resource ID.

message_countinteger required
received_countinteger required
sent_countinteger required
add_labelsstring[] required
remove_labelsstring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.