Tags can be used for a variety of things related to leads and policies. From tracking workflow changes, to hiding and revealing custom fields, lead status, and policy status buttons based on their presence of absence. Tags are becoming more and more robust and complex and can now even be manually added by users when needed. Consider them like relational sub-statuses, that can stay there permanently even as a Policy or Lead Status changes through time and work. This API allows you to programmatically add, remove and drop tags.
Tags still fulfill all their normal behaviors such as preventing the adding, removing or dropping of tags settings, as well as future tag triggers yet to come.
Endpoint: /api/ingress/tags
Methods: POST, DELETE
API Version Support: v1
Security Notice: Please make sure to use https://esotech.atlassian.net/wiki/spaces/EXTDOC/pages/186744846/API#Endpoint-Protection when giving this access to third party systems as API Keys are unprotected unless specified.
The proper endpoint protection to set for an API using this Endpoint is /api/ingress/tags*Make sure to include the *
Data Formats Supported
form-data, x-www-form-urlencoded Form Parameters or JSON Body with Content-Type: application/json set.
Response Codes
200: Success and Warnings
400: Error
Lead Tags
Add: Add Lead Tags
Endpoint: /api/ingress/tags/leads
Method: POST
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | csv|int|array - Lead IDs | One or more Lead IDs |
|
| ✓ | string|csv|int|array - Mixed Tag ID’s or Tag Names | Tag IDs or Tag Names |
|
JSON Request Object
{
"tag_id": [ "LEADTAG1", "GLOBAL2" ],
"lead_id": [ 3838035, 3838034 ]
}
JSON Success Object
{
"message": "Tags Added.",
"leads": 2,
"updated": 4,
"tags": [
7,
5
],
"errors": []
}
JSON Warning Object
{
"error": "No Tags Added.",
"leads": 2,
"updated": 0,
"tags": [
7,
5
],
"errors": [
3838035,
3838034
]
}
JSON Error Object
{
"error": "Invalid Tags were Provided",
"invalid": [
"GLOBAL2111"
]
}
Remove: Remove Lead Tags
Endpoint: /api/ingress/tags/leads
Method: DELETE
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | csv|int|array - Lead IDs | One or more Lead IDs |
|
| ✓ | string|csv|int|array - Mixed Tag ID’s or Tag Names | Tag IDs or Tag Names |
|
JSON Request Object
{
"tag_id": [ "LEADTAG1", "GLOBAL2" ],
"lead_id": [ 3838035, 3838034 ]
}
JSON Success Object
{
"message": "Tags Removed.",
"leads": 2,
"updated": 4,
"tags": [
7,
5
],
"errors": []
}
JSON Warning Object
{
"error": "No Tags Removed.",
"leads": 2,
"updated": 0,
"tags": [
7,
5
],
"errors": [
3838035,
3838034
]
}
JSON Error Object
{
"error": "Invalid Tags were Provided",
"invalid": [
"GLOBAL2111"
]
}
Drop: Drop Lead Tags
Endpoint: /api/ingress/tags/leads/drop
Method: DELETE
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | csv|int|array - Lead IDs | One or more Lead IDs |
|
JSON Request Object
{
"tag_id": [ "LEADTAG1", "GLOBAL2" ],
"lead_id": [ 3838035, 3838034 ]
}
JSON Success Object
{
"message": "Tags Dropped.",
"leads": 2,
"updated": 4,
"errors": []
}
JSON Warning Object
{
"error": "No Tags Dropped.",
"leads": 2,
"updated": 0,
"errors": [
3838035,
3838034
]
}
Policy Tags
Add: Add Policy Tags
Endpoint: /api/ingress/tags/policies
Method: POST
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | csv|int|array - Policy IDs | One or more Policy IDs |
|
| ✓ | string|csv|int|array - Mixed Tag ID’s or Tag Names | Tag IDs or Tag Names |
|
JSON Request Object
{
"tag_id": [ "POLTAG1", "GLOBAL2" ],
"lead_id": [ 235123, 235122 ]
}
JSON Success Object
{
"message": "Tags Added.",
"policies": 2,
"updated": 4,
"tags": [
6,
5
],
"errors": []
}
JSON Warning Object
{
"error": "No Tags Added.",
"policies": 2,
"updated": 0,
"tags": [
6,
5
],
"errors": [
"235123",
"235122"
]
}
JSON Error Object
{
"error": "Invalid Tags were Provided",
"invalid": [
"GLOBAL2111"
]
}
Remove: Remove Policy Tags
Endpoint: /api/ingress/tags/policies
Method: DELETE
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | csv|int|array - Policy IDs | One or more Policy IDs |
|
| ✓ | string|csv|int|array - Mixed Tag ID’s or Tag Names | Tag IDs or Tag Names |
|
JSON Request Object
{
"tag_id": [ "POLTAG1", "GLOBAL2" ],
"lead_id": [ 235123, 235122 ]
}
JSON Success Object
{
"message": "Tags Removed.",
"policies": 2,
"updated": 4,
"tags": [
6,
5
],
"errors": []
}
JSON Warning Object
{
"error": "No Tags Removed.",
"policies": 2,
"updated": 0,
"tags": [
6,
5
],
"errors": [
"235123",
"235122"
]
}
JSON Error Object
{
"error": "Invalid Tags were Provided",
"invalid": [
"GLOBAL2111"
]
}
Drop: Drop Policy Tags
Endpoint: /api/ingress/tags/policies/drop
Method: DELETE
Parameter | Required | Format | Description | Aliases |
|---|---|---|---|---|
| ✓ | csv|int|array - Policy IDs | One or more Policy IDs |
|
JSON Request Object
{
"policy_id": [ 235123, 235122 ]
}
JSON Success Object
{
"message": "Tags Dropped.",
"policies": 2,
"updated": 4,
"errors": []
}
JSON Warning Object
{
"error": "No Tags Dropped.",
"policies": 2,
"updated": 0,
"errors": [
"235123",
"235122"
]
}
Errors Possible
Error | Resolution |
|---|---|
No API ID Provided | Check API ID in Header or Parameters. See https://esotech.atlassian.net/wiki/spaces/EXTDOC/pages/186744846/API#Using-API-ID-and-API-Key |
No API Key Provided | Check API Key in Headers or Parameters. See https://esotech.atlassian.net/wiki/spaces/EXTDOC/pages/186744846/API#Using-API-ID-and-API-Key |
Tags not Provided | Check |
Leads IDs not Provided | Check |
Policy IDs not Provided | Check |
Invalid Tags were Provided | Check |
Invalid Lead IDs were provided. X / X were found. | Check |