Update Contacts Tags
Allows you to update tags to multiple contacts at once, you can add or remove tags from the contacts
POST
Update Contacts Tags
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
API Version
Available options:
2021-07-28 Body
application/json
list of contact ids to be processed
Example:
[
"qFSqySFkVvNzOSqgGqFi",
"abcdef",
"qFSqySFkVvNzOSqgGqFi",
"3ualbhnV7j3n3a9r2moD"
]list of tags to be added or removed
Example:
["tag-1", "tag-2"]location id from where the bulk request is executed
Example:
"asdrwHvLUxlfw5SqKVCN"
Option to implement remove all tags. if true, all tags will be removed from the contacts. Can only be used with remove type.
Example:
"false"
Response
Successful response
Indicates if the operation was successful
Example:
true
Number of errors encountered during the operation
Example:
0
Responses for each contact processed
Example:
[
{
"contactId": "qFSqySFkVvNzOSqgGqFi",
"message": "Tags updated",
"type": "success",
"oldTags": ["tag-1", "tag-2"],
"tagsAdded": [],
"tagsRemoved": []
},
{
"contactId": "abcdef",
"message": "contact id is not a valid firebase id",
"type": "error"
},
{
"contactId": "qFSqySFkVvNzOSqgGqFi",
"message": "contact is deleted",
"type": "error"
},
{
"contactId": "3ualbhnV7j3n3a9r2moD",
"message": "contact does not belong to location",
"type": "error"
}
]Last modified on March 8, 2026
Update Contacts Tags