Skip to main content
POST
/
contacts
/
bulk
/
tags
/
update
/
{type}
Update Contacts Tags
curl --request POST \
  --url https://services.leadconnectorhq.com/contacts/bulk/tags/update/{type} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "contacts": [
    "qFSqySFkVvNzOSqgGqFi",
    "abcdef",
    "qFSqySFkVvNzOSqgGqFi",
    "3ualbhnV7j3n3a9r2moD"
  ],
  "tags": [
    "tag-1",
    "tag-2"
  ],
  "locationId": "asdrwHvLUxlfw5SqKVCN",
  "removeAllTags": "false"
}
'
{
  "succeded": true,
  "errorCount": 0,
  "responses": [
    {
      "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"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Body

application/json
contacts
string[]
required

list of contact ids to be processed

Example:
[
"qFSqySFkVvNzOSqgGqFi",
"abcdef",
"qFSqySFkVvNzOSqgGqFi",
"3ualbhnV7j3n3a9r2moD"
]
tags
string[]
required

list of tags to be added or removed

Example:
["tag-1", "tag-2"]
locationId
string
required

location id from where the bulk request is executed

Example:

"asdrwHvLUxlfw5SqKVCN"

removeAllTags
boolean

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

succeded
boolean
required

Indicates if the operation was successful

Example:

true

errorCount
number
required

Number of errors encountered during the operation

Example:

0

responses
string[]
required

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 4, 2026