Label API

Labels allow you to organize and categorize conversations. You can create, update, and delete labels, as well as assign or remove them from conversations.

Create Label

Create a new label for your organization. If a label with the same name already exists (even if deleted), it will be restored.

Request Body:

Required:

• name - string - Label name (will be converted to lowercase)
• color - string - Label color (hex code)

curl -X POST 'https://api.supersend.io/v1/labels' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Interested",
  "color": "#4CAF50"
}'

# Response
{
  "success": true,
  "data": {
    "id": "label-uuid",
    "name": "interested",
    "color": "#4CAF50",
    "OrgId": "org-uuid",
    "CreatedBy": "user-uuid",
    "createdAt": "2025-11-27T10:30:00Z",
    "updatedAt": "2025-11-27T10:30:00Z"
  }
}

Get Labels

Get all labels for your organization. Supports search functionality.

Query Parameters:

Optional:

• search - string - Search labels by name (case-insensitive)

curl -X GET 'https://api.supersend.io/v1/labels?search=interest' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

# Response
{
  "success": true,
  "data": [
    {
      "id": "label-uuid-1",
      "name": "interested",
      "color": "#4CAF50"
    },
    {
      "id": "label-uuid-2",
      "name": "not interested",
      "color": "#F44336"
    }
  ]
}

Update Label

Update an existing label's name and/or color.

Path Parameters:

• id - string (required) - Label UUID

Request Body:

Required:

• name - string - New label name (will be converted to lowercase)
• color - string - New label color (hex code)

curl -X PUT 'https://api.supersend.io/v1/labels/<labelId>' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Very Interested",
  "color": "#2E7D32"
}'

# Response
{
  "success": true,
  "data": {
    "id": "label-uuid",
    "name": "very interested",
    "color": "#2E7D32",
    "OrgId": "org-uuid",
    "CreatedBy": "user-uuid",
    "createdAt": "2025-11-27T10:30:00Z",
    "updatedAt": "2025-11-27T10:35:00Z"
  }
}

Delete Label

Delete a label (soft delete). The label will be marked as deleted but not permanently removed.

Path Parameters:

• id - string (required) - Label UUID

curl -X DELETE 'https://api.supersend.io/v1/labels/<labelId>' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

# Response
{
  "success": true
}

Assign Label to Conversation

Assign a label to a conversation. This will automatically mark the conversation and all its messages as read (for inbox zero workflow).

Request Body:

Required:

• label_id - string - Label UUID
• conversation_id - string - Conversation UUID

curl -X POST 'https://api.supersend.io/v1/labels/conversation' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "label_id": "label-uuid",
  "conversation_id": "conversation-uuid"
}'

# Response
{
  "success": true,
  "message": "Label assigned to conversation"
}

Remove Label from Conversation

Remove a label from a conversation.

Request Body:

Required:

• label_id - string - Label UUID
• conversation_id - string - Conversation UUID

curl -X DELETE 'https://api.supersend.io/v1/labels/conversation' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json" \
-d '{
  "label_id": "label-uuid",
  "conversation_id": "conversation-uuid"
}'

# Response
{
  "success": true
}

Get Conversation Labels

Get all labels assigned to a specific conversation.

Query Parameters:

Required:

• conversation_id - string - Conversation UUID

curl -X GET 'https://api.supersend.io/v1/labels/conversation?conversation_id=conversation-uuid' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

# Response
{
  "success": true,
  "data": [
    {
      "id": "label-uuid-1",
      "name": "interested",
      "color": "#4CAF50"
    },
    {
      "id": "label-uuid-2",
      "name": "follow-up",
      "color": "#FF9800"
    }
  ]
}