Update Tags

This endpoint allows for a single conversation’s tags to be updated. The entire tag list for a conversation must be sent in the payload. Any tags existing on the conversation that are not part of the payload will be removed. To remove all tags, an empty list would be sent.

Request

PUT /v2/conversations/99/tags HTTP/1.1
Authorization: Bearer oauth_token
Content-Type: application/json; charset=UTF-8

{
  "tags" : [ "test26", "test1" ]
}

Request fields

Path Type Required Description
tags Array Y List of tags to be applied to the conversation, if the tag specified does not exist it will be first created and then applied.

Updating existing tags

To update a conversation’s existing tags, send a request that contains the new tags along with any old ones. For example if a conversation has tag a, send this request to add tag b:

{
    "tags" : ["tag a", "tag b"]
}

Removing all tags

To remove all tags, send a request with empty tags array:

{
    "tags" : []
}

Removing only one tag

To remove a tag from a conversation, list all remaining tags and omit the one you want to remove. For example if a conversation has tags tag a and tag b, send this request to only keep tag a:

{
    "tags" : ["tag a"]
}

Response

HTTP/1.1 204 No Content

Moved or merged conversations

When a conversation is moved to a new mailbox or it is merged with another conversation, it is no longer accessible using the old ID. Get Conversation endpoint will return a HTTP 301 Moved Permanently status code and the response will contain a Location header with the URI of the new conversation.

This request will return a HTTP 404 Not Found in such case. If you suspect the conversation you are trying to change was moved or merged, call the Get Conversation endpoint to get a new conversation location.