Bulk Update Contacts Tags

POSThttps://services.leadconnectorhq.com/contacts/bulk/tags/update/{type}
Allows you to update tags to multiple contacts at once, you can add or remove tags from the contacts
Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Path Parameters
type
string
required

Tags operation type

Allowed values:
addremove
Examples:
add
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28
Body
contacts
array[string]
required

list of contact ids to be processed

Example:
["qFSqySFkVvNzOSqgGqFi","abcdef","qFSqySFkVvNzOSqgGqFi","3ualbhnV7j3n3a9r2moD"]
tags
array[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

Responses

Successful response

Body

succeded
boolean
required

Indicates if the operation was successful

Example:
true
errorCount
number
required

Number of errors encountered during the operation

Example:
0
responses
array[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"}]

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request