Tags
get
Get all tags
Authorizations
Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
get
GET /tags HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"hex_color": "text",
"id": "text",
"object_type": "text",
"value": "text"
}
],
"pagination": {
"cursor": "text",
"has_next_page": true
},
"request_id": "text"
}
get
Get a tag by its ID
Authorizations
Path parameters
idstringRequired
The ID of the tag.
Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
get
GET /tags/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Accept: */*
{
"data": {
"hex_color": "text",
"id": "text",
"object_type": "text",
"value": "text"
},
"request_id": "text"
}
post
Create a new tag
Authorizations
Body
hex_colorstringOptional
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
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
post
POST /tags HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 56
{
"hex_color": "text",
"object_type": "text",
"value": "text"
}
{
"data": {
"hex_color": "text",
"id": "text",
"object_type": "text",
"value": "text"
},
"request_id": "text"
}
patch
Update an existing tag
Authorizations
Path parameters
idstringRequired
The ID of the tag to update.
Body
hex_colorstringOptional
The hex code of the tag's color.
valuestringOptional
in: body
The name of the tag.
Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
patch
PATCH /tags/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"hex_color": "text",
"value": "text"
}
{
"data": {
"hex_color": "text",
"id": "text",
"object_type": "text",
"value": "text"
},
"request_id": "text"
}
delete
Delete an existing tag
Authorizations
Path parameters
idstringRequired
The ID of the tag to update.
Responses
200Success
application/json
400Error
application/json
404Error
application/json
500Error
application/json
delete
DELETE /tags/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Accept: */*
{
"request_id": "text"
}
Last updated
Was this helpful?