curl -X POST "https://api.contactship.ai/v1/tags" \
-H "x-api-key: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead"
}'
const response = await fetch('https://api.contactship.ai/v1/tags', {
method: 'POST',
headers: {
'x-api-key': 'your-api-key',
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'hot-lead',
color: '#FF5733',
label: 'Hot Lead',
}),
});
const { data: tag } = await response.json();
console.log(`Created tag: ${tag.id}`);
import requests
response = requests.post(
'https://api.contactship.ai/v1/tags',
headers={'x-api-key': 'your-api-key'},
json={
'name': 'hot-lead',
'color': '#FF5733',
'label': 'Hot Lead',
},
)
tag = response.json()["data"]
print(f"Created tag: {tag['id']}")
{
"statusCode": 201,
"data": {
"id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-04-05T12:00:00Z"
}
}
Etiquetas
Create Tag
Create a new tag for organizing and segmenting contacts
POST
/
v1
/
tags
curl -X POST "https://api.contactship.ai/v1/tags" \
-H "x-api-key: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead"
}'
const response = await fetch('https://api.contactship.ai/v1/tags', {
method: 'POST',
headers: {
'x-api-key': 'your-api-key',
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'hot-lead',
color: '#FF5733',
label: 'Hot Lead',
}),
});
const { data: tag } = await response.json();
console.log(`Created tag: ${tag.id}`);
import requests
response = requests.post(
'https://api.contactship.ai/v1/tags',
headers={'x-api-key': 'your-api-key'},
json={
'name': 'hot-lead',
'color': '#FF5733',
'label': 'Hot Lead',
},
)
tag = response.json()["data"]
print(f"Created tag: {tag['id']}")
{
"statusCode": 201,
"data": {
"id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-04-05T12:00:00Z"
}
}
Creates a new tag in your organization. Tags can then be assigned to contacts to enable filtering, segmentation, and targeted campaigns.
Headers
Body
Hex color code for the tag (e.g.
#FF5733). Used for visual identification in the dashboard.Optional display label for the tag. Useful when you want a human-friendly name different from the system name.
Response
The response is{ "statusCode": number, "data": object }. The fields below describe data.
Error Codes
400 Bad Request— Invalid or missing required fields401 Unauthorized— Invalid or missing API key500 Internal Server Error— Server-side error
Code Examples
curl -X POST "https://api.contactship.ai/v1/tags" \
-H "x-api-key: your-api-key" \
-H "Content-Type: application/json" \
-d '{
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead"
}'
const response = await fetch('https://api.contactship.ai/v1/tags', {
method: 'POST',
headers: {
'x-api-key': 'your-api-key',
'Content-Type': 'application/json',
},
body: JSON.stringify({
name: 'hot-lead',
color: '#FF5733',
label: 'Hot Lead',
}),
});
const { data: tag } = await response.json();
console.log(`Created tag: ${tag.id}`);
import requests
response = requests.post(
'https://api.contactship.ai/v1/tags',
headers={'x-api-key': 'your-api-key'},
json={
'name': 'hot-lead',
'color': '#FF5733',
'label': 'Hot Lead',
},
)
tag = response.json()["data"]
print(f"Created tag: {tag['id']}")
{
"statusCode": 201,
"data": {
"id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "hot-lead",
"color": "#FF5733",
"label": "Hot Lead",
"organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
"created_at": "2026-04-05T12:00:00Z"
}
}
