Lets you add tags to multiple leads at the same time. To use this API –
- Pass the tag(s) name in the JSON body.
- Pass the lead numbers or “LeadAutoIds” or “ProspectAutoIds”. This value can be retrieved using the Get Lead By Id API.
API URL
Request
JSON Body/Payload
Content-Type: application/json
{
"tags": [
"New",
"Test"
],
"leadAutoIds": [
"305",
"12"
]
}
JSON Properties
{ "tags": [ "New", "Test" ], "leadAutoIds": [ "305", "12" ] }
JSON Properties
Parameter | Description |
---|---|
tags | Specify the number of lead tags that you want to associate with the lead. |
leadAutoIds | Specify the lead numbers you want to tag. You can retrieve the lead number with the variable name “ProspectAutoId”. |
Response
200 OK
Content-Type: application/json
{ "Status": "Success", "Message": { "ResponseText": "2 tag(s) added" } }
HTTP Response Code
Code | Description |
---|---|
200 OK | This is the status code for successful API call. |
401 Unauthorized | The API call was made with invalid access credentials. Check your AccessKey and SecretKey. |
400 Bad Request | The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure. |
404 Not Found | The API could not be found. Please check the API signature. |
429 Too Many Requests | API calls exceeded the limit of 25 in 5 second(s) |
500 Internal Server Error | The API called failed. There could be many reasons for it. Check the exception message to get more details. |