Skip to main content
BulkVersion: v3

Update Contacts Tags

POST/contacts/bulk/tags/update/{type}

Allows you to update tags to multiple contacts at once, you can add or remove tags from the contacts

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:contacts.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version. Send v3.

Available optionsv3
Example:v3

Path Parameters

typestringrequired

Whether to add the tags to or remove them from the contacts

Available optionsaddremove
Example:add

Body

contactsstring[]required

list of contact ids to be processed. Minimum 1, maximum 500 per request.

Possible values: >= 1, <= 500

Example:["qFSqySFkVvNzOSqgGqFi","abcdef","qFSqySFkVvNzOSqgGqFi","3ualbhnV7j3n3a9r2moD"]
tagsstring[]required

list of tags to be added or removed. Minimum 1, maximum 50 per request. Can be empty only when removeAllTags is true.

Possible values: <= 50

Example:["tag-1","tag-2"]
locationIdstringrequired

location id from where the bulk request is executed

Example:asdrwHvLUxlfw5SqKVCN
removeAllTagsboolean

Optional. If true, removes all tags from the contacts, and tags can be empty. Can only be used with the remove type. Defaults to false.

Example:false

Response

Successful response

succeededbooleanrequired

Indicates if the operation was successful

Example:true
succededbooleanrequireddeprecated

Legacy misspelling of succeeded. Deprecated; use succeeded.

Example:true
errorCountnumberrequired

Number of errors encountered during the operation

Example:0
responsesstring[]required

Responses for each contact processed