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

Query parameters

limitstringOptional

pagestringOptional

searchTextstringOptional

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

get/v1/contactTags

GET /v1/contactTags HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

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

post

Header parameters

x-api-keystringRequired

Body

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

Responses

200

200 response

application/json

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

post/v1/contactTags

POST /v1/contactTags HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 84

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

200

200 response

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

get

Path parameters

contactTagIdstringRequired

Responses

200

200 response

application/json

idstringOptional

namestringRequired

canonicalstringOptional

createdAtstringOptional

updatedAtstringOptional

get/v1/contactTags/{contactTagId}

GET /v1/contactTags/{contactTagId} HTTP/1.1
Host: <YOUR HOST>
Accept: */*

200

200 response

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

delete

Path parameters

contactTagIdstringRequired

Header parameters

x-api-keystringRequired

Responses

200

200 response

application/json

successbooleanOptional

delete/v1/contactTags/{contactTagId}

DELETE /v1/contactTags/{contactTagId} HTTP/1.1
Host: <YOUR HOST>
x-api-key: text
Accept: */*

200

200 response

{
  "success": true
}