labels

Label a received message

Adds and removes labels on one received message, leaving its other labels as they are. Names are case-sensitive: Receipts and receipts are different labels. The response lists the message's labels after the change, and repeating a change is harmless.

To track read and starred mail with labels, see Track read, unread and starred mail.

patch/v1/messages/{message_id}

Request

  • Base URL: https://cherami.to
  • URL: https://cherami.to/v1/messages/{message_id}
  • Auth: HTTP bearer

Path parameters

message_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.

labelsstring[] required

Changes

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