| Parameter name | Value | Description |
|---|---|---|
id |
string |
Identifier of the tag. |
tag |
string |
Text of the tag. |
color |
string |
Color of the tag. Hexadecimal web color. |
numberOfContacts |
integer |
Number of contact linked with the tag. Read-only. |
Authentication is required to execute this request. Please refer to Authentication for more.
{tagId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
tagId |
string |
Tag identifier. |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{tagId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
tagId |
string |
Tag identifier. |
Do not supply a request body with this method.
If successful, this method returns a Tag resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
| Parameter name | Value | Description |
|---|---|---|
| Required query parameters | ||
apiKey |
string |
API Key |
| Optional query parameters | ||
contactId |
string |
Identifier of the contact. |
withContactCount |
boolean |
to retrieve nomber of contacts per tag. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Authentication is required to execute this request. Please refer to Authentication for more.
In the request body, supply a Tag Resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Required Properties | ||
tag |
string |
Text of the tag. |
| Optional Properties | ||
color |
string |
Color of the tag. Hexadecimal web color. |
If successful, this method returns a Tag resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{tagId}| Parameter name | Value | Description |
|---|---|---|
| Path parameters | ||
tagId |
string |
Note identifier. |
In the request body, supply a Tag resource with the following properties:
| Parameter name | Value | Description |
|---|---|---|
| Optional Properties | ||
tag |
string |
Text of the tag. |
color |
string |
Color of the tag. Hexadecimal web color. |
If successful, this method returns a Tag resource in the response body.