Tags

Tags are labels that can be applied to contacts, companies, conversations, helpdesk articles, and deals to help organize and categorize your data.

The Tag Object

  • Name
    id
    Type
    uuid
    Description

    Unique identifier for the tag.

  • Name
    workspace_id
    Type
    uuid
    Description

    The workspace this tag belongs to.

  • Name
    name
    Type
    string
    Description

    Tag name (max 255 characters).

  • Name
    background_color
    Type
    string
    Description

    Hex color code for the tag background (e.g., #3B82F6).

  • Name
    text_color
    Type
    string
    Description

    Hex color code for the tag text (e.g., #FFFFFF).

  • Name
    sort
    Type
    integer
    Description

    Sort order for displaying tags. Lower numbers appear first.

  • Name
    created_at
    Type
    datetime
    Description

    Timestamp when the tag was created.

  • Name
    updated_at
    Type
    datetime
    Description

    Timestamp when the tag was last updated.

GET/app/tags

List Tags

Retrieve all tags in your workspace.

Request

GET
/app/tags
curl https://api.pipeback.com/app/tags \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
  "data": [
    {
      "id": "9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8a",
      "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
      "name": "VIP",
      "background_color": "#3B82F6",
      "text_color": "#FFFFFF",
      "sort": 1,
      "created_at": "2025-01-15 10:00:00",
      "updated_at": "2025-01-15 10:00:00"
    },
    {
      "id": "9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8b",
      "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
      "name": "Enterprise",
      "background_color": "#8B5CF6",
      "text_color": "#FFFFFF",
      "sort": 2,
      "created_at": "2025-01-15 10:05:00",
      "updated_at": "2025-01-15 10:05:00"
    }
  ]
}
POST/app/tags

Create a Tag

Create a new tag in your workspace. The tag will be automatically assigned a sort order based on the current number of tags.

Required Attributes

  • Name
    name
    Type
    string
    Required
    *
    Description

    Tag name (max 255 characters).

  • Name
    background_color
    Type
    string
    Required
    *
    Description

    Hex color code for the tag background (e.g., #3B82F6).

  • Name
    text_color
    Type
    string
    Required
    *
    Description

    Hex color code for the tag text (e.g., #FFFFFF).

Request

POST
/app/tags
curl -X POST https://api.pipeback.com/app/tags \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Premium Customer",
    "background_color": "#10B981",
    "text_color": "#FFFFFF"
  }'

Response

{
  "data": {
    "id": "9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8c",
    "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
    "name": "Premium Customer",
    "background_color": "#10B981",
    "text_color": "#FFFFFF",
    "sort": 3,
    "created_at": "2025-10-26 16:00:00",
    "updated_at": "2025-10-26 16:00:00"
  }
}
PUT/app/tags/{id}

Update a Tag

Update an existing tag's properties.

Required Attributes

  • Name
    name
    Type
    string
    Required
    *
    Description

    Tag name (max 255 characters).

  • Name
    background_color
    Type
    string
    Required
    *
    Description

    Hex color code for the tag background.

  • Name
    text_color
    Type
    string
    Required
    *
    Description

    Hex color code for the tag text.

Request

PUT
/app/tags/{id}
curl -X PUT https://api.pipeback.com/app/tags/9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8a \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "VIP Customer",
    "background_color": "#EF4444",
    "text_color": "#FFFFFF"
  }'

Response

{
  "data": {
    "id": "9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8a",
    "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
    "name": "VIP Customer",
    "background_color": "#EF4444",
    "text_color": "#FFFFFF",
    "sort": 1,
    "created_at": "2025-01-15 10:00:00",
    "updated_at": "2025-10-26 16:15:00"
  }
}
DELETE/app/tags/{id}

Delete a Tag

Delete a tag from your workspace. This will remove the tag from all associated resources (contacts, companies, conversations, etc.).

Request

DELETE
/app/tags/{id}
curl -X DELETE https://api.pipeback.com/app/tags/9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8a \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID"

Response

{
  "data": {
    "id": "9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8a",
    "workspace_id": "9d5f3cf9-fa6f-498b-b5be-bd078b7d5339",
    "name": "VIP Customer",
    "background_color": "#EF4444",
    "text_color": "#FFFFFF",
    "sort": 1,
    "created_at": "2025-01-15 10:00:00",
    "updated_at": "2025-10-26 16:15:00"
  }
}
POST/app/tags/sync

Sync Tags

Synchronize tags for a specific resource. This will replace all existing tags on the resource with the provided tags.

Required Attributes

  • Name
    model_id
    Type
    uuid
    Required
    *
    Description

    The ID of the resource to sync tags with.

  • Name
    model
    Type
    string
    Required
    *
    Description

    The type of resource. Must be one of: Contact, Company, Conversation, HelpdeskArticle.

  • Name
    tags
    Type
    array
    Required
    *
    Description

    Array of tag objects with id property. This will replace all existing tags.

Request

POST
/app/tags/sync
curl -X POST https://api.pipeback.com/app/tags/sync \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "x-workspace-id: YOUR_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "model_id": "9d5f3d04-2c61-4d1a-8a3e-1b2c3d4e5f6a",
    "model": "Contact",
    "tags": [
      { "id": "9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8a" },
      { "id": "9d5f3d04-4d81-6f3c-0c5g-3d4e5f6g7h8b" }
    ]
  }'

Response

{
}

Supported Models

Tags can be applied to the following resource types:

  • Name
    Contact
    Description

    Individual contacts in your workspace.

  • Name
    Company
    Description

    Companies and organizations.

  • Name
    Conversation
    Description

    Support conversations and messages.

  • Name
    HelpdeskArticle
    Description

    Help center articles and documentation.

Something wrong with this page?