Custom Fields

get

Get all custom fields

Authorizations

Query parameters

object_typestringrequired

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

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.usepylon.com/custom-fields?object_type=text' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

200

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

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

400

404

500

200

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

select_optionsobject[]optional

The list options of the select custom field. This is only present for select and multiselect custom fields.

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

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/custom-fields' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "default_value": "text",
    "default_values": [
      "text"
    ],
    "description": "text",
    "label": "text",
    "object_type": "text",
    "select_options": [
      {
        "label": "text",
        "slug": "text"
      }
    ],
    "slug": "text",
    "type": "text"
  }'

200

400

404

500

200

{
  "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.

select_optionsobject[]optional

The list options of the select custom field. This is only present for select and multiselect custom fields.

slugstringoptional

The slug of the custom field.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://api.usepylon.com/custom-fields/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "default_value": "text",
    "default_values": [
      "text"
    ],
    "description": "text",
    "label": "text",
    "select_options": [
      {
        "label": "text",
        "slug": "text"
      }
    ],
    "slug": "text"
  }'

200

400

404

500

200

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