Skip to content
Home/
REST API Reference
/
/
Tag

Tag

A tag allows you to label your contacts, companies, and conversations and list them using that tag.

typestringrequired

value is "tag"

Example:"tag"
idstringrequired

The id of the tag

Example:"123456"
namestringrequired

The name of the tag

Example:"Test tag"
applied_atinteger or null, (date-time)required

The time when the tag was applied to the object. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.

Example:1663597223
applied_byobject or null(Reference)required

The admin who applied the tag. Only present when the tag is returned as part of a tagging operation on a contact, conversation, or ticket.

{
  "type": "tag",
  "id": "123456",
  "name": "Test tag",
  "applied_at": 1663597223,
  "applied_by": {
    "type": "contact",
    "id": "1a2b3c"
  }
}