Skip to main content
POST
/
api
/
tags
Create a new tag
curl --request POST \
  --url https://api.atendai.com/api/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example",
  "color": "#5300eb",
  "kanban": 0,
  "order": 0,
  "companyId": "3708fcdf-954b-48f8-91ff-25babaccac67"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "color": "<string>",
  "order": 123,
  "companyId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "kanban": 123,
  "contacts": [
    {
      "id": "<string>",
      "name": "<string>",
      "number": "<string>",
      "email": "<string>",
      "profilePicUrl": "<string>",
      "isGroup": true,
      "isAdmin": true,
      "isOpen": true,
      "isBotEnabled": true,
      "utmCampaign": "<string>",
      "utmContent": "<string>",
      "utmMedium": "<string>",
      "utmSource": "<string>",
      "utmTerms": "<string>",
      "active": true,
      "channel": "<string>",
      "whatsappId": "<string>",
      "companyId": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

Name of the tag

Example:

"Example"

​
color
string
required

Color code of the tag

Example:

"#5300eb"

​
kanban
number
required

Kanban value of the tag

Example:

0

​
order
number
required

Order value of the tag

Example:

0

​
companyId
string
required

ID of the company associated with the tag

Example:

"3708fcdf-954b-48f8-91ff-25babaccac67"

Response

Tag created successfully

​
id
string
required
​
name
string
required
​
color
string
required
​
order
integer
required
​
companyId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
kanban
integer
​
contacts
object[]