Tags | Pylon

Get all tags.

GEThttps://api.usepylon.com/tags

Response

Body

dataarray of Tag (object)

The data payload of the response.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/tags', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Get a tag by its ID.

GEThttps://api.usepylon.com/tags/{id}

Path parameters

id*string

The ID of the tag.

Response

Body

dataTag (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/tags/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Create a new tag.

POSThttps://api.usepylon.com/tags

Body

hex_colorstring

The hex code of the tag's color.

object_type*string

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

value*string

The tag value.

Response

Body

dataTag (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/tags', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "object_type": "text",
      "value": "text"
    }),
});
const data = await response.json();

Response

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

Update an existing tag.

PATCHhttps://api.usepylon.com/tags/{id}

Path parameters

id*string

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.

Response

Body

dataTag (object)

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/tags/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Delete an existing tag.

DELETEhttps://api.usepylon.com/tags/{id}

Path parameters

id*string

The ID of the tag to update.

Response

Body

request_idstring

The request ID for tracking.

Request

const response = await fetch('https://api.usepylon.com/tags/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "request_id": "text"
}