Custom Fields
Get all custom fields
The object type of the custom fields. Can be "account", "issue", or "contact".
GET /custom-fields HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Accept: */*
{
"data": [
{
"created_at": "text",
"default_value": "text",
"default_values": [
"text"
],
"description": "text",
"id": "text",
"is_read_only": true,
"label": "text",
"object_type": "text",
"select_metadata": {
"options": [
{
"label": "text",
"slug": "text"
}
]
},
"slug": "text",
"source": "text",
"type": "text",
"updated_at": "text"
}
],
"pagination": {
"cursor": "text",
"has_next_page": true
},
"request_id": "text"
}
Get a custom field by its ID
The ID of the custom field.
GET /custom-fields/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Accept: */*
{
"data": {
"created_at": "text",
"default_value": "text",
"default_values": [
"text"
],
"description": "text",
"id": "text",
"is_read_only": true,
"label": "text",
"object_type": "text",
"select_metadata": {
"options": [
{
"label": "text",
"slug": "text"
}
]
},
"slug": "text",
"source": "text",
"type": "text",
"updated_at": "text"
},
"request_id": "text"
}
Create a custom field
The default value for single-valued custom fields.
The default values for multi-valued custom fields.
The description of the custom field.
The label of the custom field.
The object type of the custom field. Can be "account", "issue", or "contact"
The slug of the custom field.
The type of the custom field. Can be one of text
, number
, decimal
, boolean
, date
, datetime
, user
, url
, select
, or multiselect
.
POST /custom-fields HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 185
{
"default_value": "text",
"default_values": [
"text"
],
"description": "text",
"label": "text",
"object_type": "text",
"select_options": [
{
"label": "text",
"slug": "text"
}
],
"slug": "text",
"type": "text"
}
{
"data": {
"created_at": "text",
"default_value": "text",
"default_values": [
"text"
],
"description": "text",
"id": "text",
"is_read_only": true,
"label": "text",
"object_type": "text",
"select_metadata": {
"options": [
{
"label": "text",
"slug": "text"
}
]
},
"slug": "text",
"source": "text",
"type": "text",
"updated_at": "text"
},
"request_id": "text"
}
Update a custom field
The ID of the custom field.
The default value for single-valued custom fields.
The default values for multi-valued custom fields.
The description of the custom field.
The label of the custom field.
The slug of the custom field.
PATCH /custom-fields/{id} HTTP/1.1
Host: api.usepylon.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 150
{
"default_value": "text",
"default_values": [
"text"
],
"description": "text",
"label": "text",
"select_options": [
{
"label": "text",
"slug": "text"
}
],
"slug": "text"
}
{
"data": {
"created_at": "text",
"default_value": "text",
"default_values": [
"text"
],
"description": "text",
"id": "text",
"is_read_only": true,
"label": "text",
"object_type": "text",
"select_metadata": {
"options": [
{
"label": "text",
"slug": "text"
}
]
},
"slug": "text",
"source": "text",
"type": "text",
"updated_at": "text"
},
"request_id": "text"
}
Last updated
Was this helpful?