Saltar al contenido principal
PATCH
/
v1
/
tags
/
{tagId}
curl -X PATCH "https://api.contactship.ai/v1/tags/tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "x-api-key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"label": "Very Hot Lead", "color": "#FF0000"}'
{
  "id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "hot-lead",
  "color": "#FF0000",
  "label": "Very Hot Lead",
  "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
  "updated_at": "2026-04-06T14:00:00Z"
}
Updates the name, color, or label of an existing tag.

Headers

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

Path Parameters

tagId
string
requerido
The UUID of the tag to update.

Body

name
string
New name for the tag.
color
string
New hex color code (e.g. #3498DB).
label
string
New display label.

Response

id
string
UUID of the updated tag.
name
string
Updated tag name.
color
string
Updated hex color code.
label
string
Updated display label.
organization_id
string
UUID of the organization that owns this tag.
updated_at
string
Timestamp of the last update (ISO 8601).

Error Codes

  • 400 Bad Request — Invalid fields
  • 401 Unauthorized — Invalid or missing API key
  • 404 Not Found — Tag not found
  • 500 Internal Server Error — Server-side error

Code Examples

curl -X PATCH "https://api.contactship.ai/v1/tags/tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "x-api-key: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{"label": "Very Hot Lead", "color": "#FF0000"}'
{
  "id": "tag-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "hot-lead",
  "color": "#FF0000",
  "label": "Very Hot Lead",
  "organization_id": "org-f1e2d3c4-b5a6-7890-1234-567890abcdef",
  "updated_at": "2026-04-06T14:00:00Z"
}