Skip to main content
PATCH
Update a custom field definition
Update an existing custom field definition.

Path parameters

Request body

Provide the fields you want to update, such as display_name, description, validation, or default_format.

Notes

You cannot change api_slug, entity_type, or data_type after creation.

Authorizations

Authorization
string
header
required

Token YOUR_API_TOKEN

The APIs require authentication to be done using header-based API Key and Secret Authentication.

API key and secret are sent va the Authorization request header.

You send your API key and secret in the following way:

Authorization: Token YOUR_API_KEY

Path Parameters

id
string
required

Custom field definition ID

Body

application/json
data
object

Response

200 - application/json

OK

data
Custom field definition ยท object