Contact Tags
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | Yes | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | Yes |
More information about roles may be found here.
Available Services
All Tags
/<API Version>/contacts/tags
| HTTP Method | Description | Notes |
|---|---|---|
| GET | Returns a list of all tags for the current user | |
| POST | Creates a new tag | |
| PUT,DELETE | Returns HTTP 405 (Method Not Allowed) | Not implemented |
GET Request
No parameters
GET Response
Example:
{
"D": {
"Success": true,
"Results": [{
"ResourceUri": "/v1/contacts/tags/IDX Lead",
"Tag": "IDX Lead"
},
{
"ResourceUri": "/v1/contacts/tags/Active Buyers",
"Tag": "Active Buyers"
}]
}
}
POST Request
Request Body
{
"D": {
"Tag": "A New Tag"
}
}
POST Response
The standard success/fail response is returned.
Individual Tags
/<API Version>/contacts/tags/<Tag>
| HTTP Method | Description | Notes |
|---|---|---|
| GET | Returns all contacts for the specified tag | See the related documentation on escaping reserved characters in URLs |
| POST,PUT | Returns HTTP 405 (Method Not Allowed) | Not implemented |
| DELETE | Destroy an existing tag. |
Get Request
Parameters:
- None
GET Response
Example:
{
"D": {
"Success": true,
"Results": [{
"ResourceUri": "/vX/contacts/201010122342756895000000",
"Id": "201010122342756895000000",
"DisplayName": "Some Person",
"PrimaryEmail": "test@test.com",
"Tags": ["IDX Lead"]
}, {
"ResourceUri": "/vX/contacts/201010126342351895000000",
"Id": "201010126342351895000000",
"DisplayName": "Another Contact",
"PrimaryEmail": "me@contact.com",
"Tags": ["IDX Lead", "Active Buyers]
}]
}
}
Delete Request
Parameters:
- None
DELETE Response
The standard success/fail response is returned.
Contact Tags Description
| Attribute | Data Type | Writeable | Required | Description |
|---|---|---|---|---|
ResourceUri |
Character | No | No | The URI to the Tag |
Tag |
Character | Yes | Yes | The Contact Tag name. Maximum 75 characters. |
Expansions
None.