Contact Tag API

Organize and manage your contact tags for segmentation and advanced filtering using the Contact Tag API endpoints.

---

Endpoints

1. List/Search Contact Tags

GET /v1/contactTags

• Description: Retrieve a list of contact tags with optional filtering and search.
• Authentication: Requires x-api-key header.

Query Parameters:

Name	In	Type	Required	Description
limit	query	string	No	Max number of results
page	query	string	No	Page number for pagination
searchText	query	string	No	Free text search
x-api-key	header	string	Yes	API authentication key

Response: [200 OK] - Array of ContactTag

---

2. Create a Contact Tag

POST /v1/contactTags

• Description: Create a new contact tag.
• Authentication: Requires x-api-key header.

Request Body: ContactTag (application/json)

Response: [200 OK] - ContactTag

---

3. Get Contact Tag by ID

GET /v1/contactTags/{contactTagId}

• Description: Retrieve a contact tag by its unique ID.
• Authentication: Requires x-api-key header.

Path Parameters:

Name	In	Type	Required	Description
contactTagId	path	string	Yes	Contact tag unique ID
x-api-key	header	string	Yes	API authentication key

Response: [200 OK] - ContactTag

---

4. Delete Contact Tag by ID

DELETE /v1/contactTags/{contactTagId}

• Description: Delete a contact tag by its unique ID.
• Authentication: Requires x-api-key header.

Path Parameters:

Name	In	Type	Required	Description
contactTagId	path	string	Yes	Contact tag unique ID
x-api-key	header	string	Yes	API authentication key

Response: [200 OK] - DeleteResponse

---

Schemas

ContactTag Schema

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

DeleteResponse Schema

{
  "success": true
}