Knowledge Base Website Changelog Book a Demo Login

Tags

PreviousMe NextTeams

Last updated 4 months ago

Was this helpful?

Get all tags

get

/tags

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/tags' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "data": [
    {
      "hex_color": "text",
      "id": "text",
      "object_type": "text",
      "value": "text"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Get a tag by its ID

get

/tags/{id}

Authorizations

Path parameters

idstringrequired

The ID of the tag.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/tags/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "data": {
    "hex_color": "text",
    "id": "text",
    "object_type": "text",
    "value": "text"
  },
  "request_id": "text"
}

Create a new tag

post

/tags

Authorizations

Body

hex_colorstring

The hex code of the tag's color.

object_typestringrequired

The object type of the associated object. Can be "account", "issue", or "contact".

valuestringrequired

The tag value.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/tags' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "hex_color": "text",
    "object_type": "text",
    "value": "text"
  }'

200

400

404

500

{
  "data": {
    "hex_color": "text",
    "id": "text",
    "object_type": "text",
    "value": "text"
  },
  "request_id": "text"
}

Update an existing tag

patch

/tags/{id}

Authorizations

Path parameters

idstringrequired

The ID of the tag to update.

Body

hex_colorstring

The hex code of the tag's color.

valuestring

in: body

The name of the tag.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.usepylon.com/tags/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "hex_color": "text",
    "value": "text"
  }'

200

400

404

500

{
  "data": {
    "hex_color": "text",
    "id": "text",
    "object_type": "text",
    "value": "text"
  },
  "request_id": "text"
}

Delete an existing tag

delete

/tags/{id}

Authorizations

Path parameters

idstringrequired

The ID of the tag to update.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.usepylon.com/tags/{id}' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "request_id": "text"
}