patch/threads/{threadId}/labels

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/threads/{threadId}/labels
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

threadIdstring required

Conversation to relabel — every message in it is updated

Request body

addLabelsstring[]

Labels to add to every message in the thread. Adding read removes unread and vice versa, per message, exactly as the single-message route does.

removeLabelsstring[]

Labels to remove from every message in the thread.

Response

OK

threadIdstring required

The conversation that was relabelled

updatedCountinteger required

How many messages were written. Zero means the thread does not exist or is not yours — it is never a silent success.

Changes

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