Pular para o conteúdo
ZaiaZaiaZaia

/api/v1/tickets/{ticketId}/tags

POST
/api/v1/tickets/{ticketId}/tags
curl --request POST \
  --url https://api.endless.zaia.app/api/v1/tickets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tags \
  --header 'Content-Type: application/json' \
  --data '{ "tagId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Creates tags for a ticket.

Parameters

Seção intitulada “Parameters”

Path Parameters

Seção intitulada “Path Parameters”
ticketId
required

A UUID v4 string that identifies an entity.

string format: uuid

A UUID v4 string that identifies an entity.

Request Bodyrequired

Seção intitulada “Request Bodyrequired”
Media typeapplication/json
object
tagId
required

A UUID v4 string that identifies an entity.

string format: uuid
Examplegenerated
{
  "tagId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Seção intitulada “Responses”

200

Seção intitulada “200”

The tag was attached to the ticket.

Media typeapplication/json
object
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
tagId
required

The tag associated with the ticket.

string format: uuid
ticketId
required

The ticket associated with the tag.

string format: uuid
tag
required
object
createdAt
required
string format: date-time
id
required

A UUID v4 string that identifies an entity.

string format: uuid
updatedAt
required
string format: date-time
activeTicketCount
required

The number of distinct pending or ongoing tickets linked to this tag via ticket_tags or chat_tags.

integer
color
required

The color of the tag.

string
Allowed values: default gray red orange yellow green blue purple pink brown
description
required

The description of the tag.

string
>= 3 characters <= 250 characters
name
required

The display name of the tag.

string
>= 3 characters <= 50 characters
workspaceId
required

The workspace that owns this tag.

string format: uuid
Example
{
  "tag": {
    "color": "default"
  }
}

401

Seção intitulada “401”

Unauthorized.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}

404

Seção intitulada “404”

Ticket or tag not found.

Media typeapplication/json

The description of a known exception.

object
code

The error code.

string
cta

The error call-to-action.

object
type
required
string
Allowed values: support-contact
url
required
string format: uri
feedback
required

The error feedback.

object
enUs
string
esEs
string
ptBr
string
message
required

The error message.

string
name
required

The error name.

string
Example
{
  "cta": {
    "type": "support-contact"
  }
}