Update Custom Field
Update a custom field.
Scopes: custom_fields:write
Authorizations
You can generate an Organization Access Token from your organization's settings.
Path Parameters
The custom field ID.
Body
Schema to update a custom field of type text.
"text"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Name of the custom field.
1
Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.
1
Schema to update a custom field of type text.
"text"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Name of the custom field.
1
Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.
1
Schema to update a custom field of type number.
"number"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Name of the custom field.
1
Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.
1
Schema to update a custom field of type date.
"date"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Name of the custom field.
1
Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.
1
Schema to update a custom field of type checkbox.
"checkbox"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Name of the custom field.
1
Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.
1
Schema to update a custom field of type select.
"select"
Key-value object allowing you to store additional information.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Name of the custom field.
1
Identifier of the custom field. It'll be used as key when storing the value. Must be unique across the organization.It can only contain ASCII letters, numbers and hyphens.
1
Response
Schema for a custom field of type text.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"text"
Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Schema for a custom field of type text.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"text"
Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Schema for a custom field of type number.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"number"
Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Schema for a custom field of type date.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"date"
Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Schema for a custom field of type checkbox.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"checkbox"
Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
Schema for a custom field of type select.
Creation timestamp of the object.
Last modification timestamp of the object.
The ID of the object.
"select"
Identifier of the custom field. It'll be used as key when storing the value.
Name of the custom field.
The ID of the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"