Custom Fields

Pylon

Knowledge Base Website Changelog Book a Demo Login

get

Get all custom fields

Authorizations

Query parameters

object_typestringRequired

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

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

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

Get a custom field by its ID

Authorizations

Path parameters

idstringRequired

The ID of the custom field.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

get

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"
}

post

Create a custom field

Authorizations

Body

default_valuestringOptional

The default value for single-valued custom fields.

default_valuesstring[]Optional

The default values for multi-valued custom fields.

descriptionstringOptional

The description of the custom field.

labelstringRequired

The label of the custom field.

object_typestringRequired

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

slugstringOptional

The slug of the custom field.

typestringRequired

The type of the custom field. Can be one of text, number, decimal, boolean, date, datetime, user, url, select, or multiselect.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

post

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"
}

patch

Update a custom field

Authorizations

Path parameters

idstringRequired

The ID of the custom field.

Body

default_valuestringOptional

The default value for single-valued custom fields.

default_valuesstring[]Optional

The default values for multi-valued custom fields.

descriptionstringOptional

The description of the custom field.

labelstringOptional

The label of the custom field.

slugstringOptional

The slug of the custom field.

Responses

200Success

application/json

400Error

application/json

404Error

application/json

500Error

application/json

patch

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"
}