inboxes > threads

Updates thread labels. Cannot add or remove system labels (sent, received, bounced, etc.). Rejects requests with a 422 for threads with 100 or more messages.

patch/v0/inboxes/{inbox_id}/threads/{thread_id}

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/inboxes/{inbox_id}/threads/{thread_id}
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

The ID of the inbox.

thread_idstring required

ID of thread.

Request body

add_labelsstring[]

Labels to add to thread. Cannot be system labels.

remove_labelsstring[]

Labels to remove from thread. Cannot be system labels. Takes priority over add_labels (in the event of duplicate labels passed in).

Response

Response with status 200

thread_idstring required

ID of thread.

labelsstring[] required

Labels of thread.

Changes

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag inboxes > threads added

    • info

      api tag InboxesThreads removed

    • info

      request body became optional

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status