Developers

# Conversation tags

Manage all your conversation tags through this endpoint.

# The tag object

  • id integer

    The system-generated ID of the tag.

  • tag string

    The friendly name of the tag.

  • color string

    The tag color. For example #da5100.

  • created_at string

    The timestamp when the tag was created.

  • updated_at string

    The timestamp when the tag was last updated.

{
  "id": 1,
  "tag": "My tag",
  "color": "#da5100",
  "updated_at": "2019-06-01T16:12:25+00:00",
  "created_at": "2019-06-01T16:12:25+00:00"
}

# Create a conversation tag

  • tag string required

    The friendly name of the tag.

  • color string optional

    The tag color. For example #da5100.

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/conversation-tags \
  --request POST \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -d tag="Needs follow-up" \
  -d color="#da5100"

# Sample successful response

{
  "id": 1,
  "tag": "Needs follow-up",
  "color": "#da5100",
  "updated_at": "2019-06-01T16:12:25+00:00",
  "created_at": "2019-06-01T16:12:25+00:00"
}

# Retrieve a conversation tag

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/conversation-tags/1 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -G

# Sample successful response

{
  "id": 1,
  "tag": "Needs follow-up",
  "color": "#da5100",
  "updated_at": "2019-06-01T16:12:25+00:00",
  "created_at": "2019-06-01T16:12:25+00:00"
}

# Update a conversation tag

  • tag string required

    The friendly name of the tag.

  • color string optional

    The tag color. For example #da5100.

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/conversation-tags/1 \
  --request PUT \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>" \
  -d tag="Needs Follow-up"

# Sample successful response

{
  "id": 1,
  "tag": "Needs Follow-up",
  "color": "#da5100",
  "updated_at": "2019-06-01T16:12:25+00:00",
  "created_at": "2019-06-01T16:12:25+00:00"
}

# Delete a conversation tag

curl https://www.yourdomain.com/api/v1/accounts/1/conversation-tags/1 \
  --request DELETE \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>"

If successful, the above request will return an empty response with 204 HTTP status code.

# List all conversation tags

# Sample request

curl https://www.yourdomain.com/api/v1/accounts/1/conversation-tags \
  -G \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <access-token>"

# Sample successful response

{
  "data": [
    {
      "id": 1,
      "tag": "Needs Follow-up",
      "color": "#da5100",
      "updated_at": "2019-06-01T16:12:25+00:00",
      "created_at": "2019-06-01T16:12:25+00:00"
    },
    {...}
  ]
}

← System Settings →