Contact Tags

Contact tags play a pivotal role in categorizing and organizing contacts within the platform, enabling personalized engagement strategies.

Explore the following functionalities related to Contact Tags:

• Search Contact Tags: Conduct targeted searches for specific tags, empowering efficient retrieval and utilization of tag-related information.

• Add Contact Tag: Utilize this endpoint to associate new tags with contacts, enabling seamless categorization and organization.

• Get Contact Tag By ID: Access detailed information about a specific contact tag by providing its unique identifier. This endpoint enables developers to retrieve specific tag details for targeted analysis and customization.

• Delete Contact Tag: Effortlessly remove tags associated with contacts, facilitating flexible tag management and optimization of contact information.

get

/v1/contactTags

Query parameters

limitstring

pagestring

searchTextstring

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/contactTags' \
  --header 'x-api-key: text'

200

200

[
  {
    "id": "text",
    "name": "text",
    "canonical": "text",
    "createdAt": "text",
    "updatedAt": "text"
  }
]

200 response

post

/v1/contactTags

Header parameters

x-api-keystringrequired

Body

idstring

namestringrequired

canonicalstring

createdAtstring

updatedAtstring

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<YOUR HOST>/v1/contactTags' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{"name":"text"}'

200

200

{
  "id": "text",
  "name": "text",
  "canonical": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

200 response

get

/v1/contactTags/{contactTagId}

Path parameters

contactTagIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://<YOUR HOST>/v1/contactTags/{contactTagId}'

200

200

{
  "id": "text",
  "name": "text",
  "canonical": "text",
  "createdAt": "text",
  "updatedAt": "text"
}

200 response

delete

/v1/contactTags/{contactTagId}

Path parameters

contactTagIdstringrequired

Header parameters

x-api-keystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://<YOUR HOST>/v1/contactTags/{contactTagId}' \
  --header 'x-api-key: text'

200

200

{
  "success": true
}

200 response