Saltar al contenido principal
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"
  }'
{
  "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

x-api-key
string
requerido
Your API key for authentication. Found in your dashboard under API settings.

Body

name
string
requerido
The tag name. Must be unique within your organization.
color
string
requerido
Hex color code for the tag (e.g. #FF5733). Used for visual identification in the dashboard.
label
string
Optional display label for the tag. Useful when you want a human-friendly name different from the system name.

Response

id
string
Unique identifier of the created tag (UUID).
name
string
The tag name.
color
string
Hex color code of the tag.
label
string
Display label of the tag, if set.
organization_id
string
UUID of the organization that owns this tag.
created_at
string
Timestamp when the tag was created (ISO 8601).

Error Codes

  • 400 Bad Request — Invalid or missing required fields
  • 401 Unauthorized — Invalid or missing API key
  • 500 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"
  }'
{
  "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"
}