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.

GEThttps://<YOUR HOST>/v1/contactTags

Query parameters

Header parameters

Response

200

200 response

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/contactTags', {
    method: 'GET',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

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

POSThttps://<YOUR HOST>/v1/contactTags

Header parameters

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Response

200

200 response

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/contactTags', {
    method: 'POST',
    headers: {
      "x-api-key": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text"
    }),
});
const data = await response.json();

Response

200

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

GEThttps://<YOUR HOST>/v1/contactTags/{contactTagId}

Path parameters

contactTagId*string

Response

200

200 response

Body

application/json

idstring

name*string

canonicalstring

createdAtstring

updatedAtstring

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/contactTags/{contactTagId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

DELETEhttps://<YOUR HOST>/v1/contactTags/{contactTagId}

Path parameters

contactTagId*string

Header parameters

Response

200

200 response

Body

application/json

successboolean

Request

JavaScriptCurlPython

const response = await fetch('https://<YOUR HOST>/v1/contactTags/{contactTagId}', {
    method: 'DELETE',
    headers: {
      "x-api-key": "text"
    },
});
const data = await response.json();

Response

200

{
  "success": false
}