Skip to main content
POST
/
tag
curl --request POST \
  --url https://api.sendx.io/api/v1/rest/tag \
  --header 'Content-Type: application/json' \
  --header 'X-Team-ApiKey: <api-key>' \
  --data '
{
  "name": "VIP Customer"
}
'
{
  "id": "tag_abc123def456ghi789",
  "name": "VIP Customer",
  "created": "2024-01-20T10:30:00Z",
  "updated": "2024-01-20T10:30:00Z"
}
🎯 Purpose: Tags provide flexible contact categorization beyond traditional lists, enabling:
  • Dynamic segmentation based on behavior
  • Multi-dimensional contact grouping
  • Temporary or permanent categorization
  • Cross-team tag sharing (with isShareable flag)
💡 Use Cases:
  • Customer lifecycle stages (lead, prospect, customer, VIP)
  • Behavioral tags (engaged, inactive, power-user)
  • Product interests (feature-A-user, beta-tester)
  • Event attendance (webinar-2024-Q1, conference-attendee)
🔄 Tag Assignment: Tags can be assigned to contacts through:
  • API calls (contact creation/update)
  • Automation workflows
  • Manual bulk actions
  • Import operations
⚡ Best Practices:
  • Use descriptive tag names
  • Establish naming conventions
  • Regularly review and clean up unused tags
  • Consider tag hierarchies for complex segmentation

Authorizations

​
X-Team-ApiKey
string
header
required

Team API key for authentication. Find your API key in SendX Settings → Team API Key.

Example:

X-Team-ApiKey: your_team_api_key_here

Body

application/json
​
name
string
required

Tag name (must be unique within team)

Example:

"VIP Customer"

Response

✅ Tag created successfully

​
id
string

Unique tag identifier with tag_ prefix

Pattern: ^tag_[a-zA-Z0-9]{22}$
Example:

"tag_abc123def456ghi789"

​
name
string

Tag name

Example:

"VIP Customer"

​
created
string<date-time>

Tag creation timestamp

Example:

"2024-01-20T10:30:00Z"

​
updated
string<date-time>

Tag last update timestamp

Example:

"2024-01-20T10:30:00Z"