API Reference

Update a custom field

put
https://{domain}.gorgias.com/api/custom-fields/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The ID of the custom field to update.

Body Params

When the custom field was deactivated.

definition

The settings for this custom field, dependent on the data type.

length between 0 and 1024

The description of the custom field.

ID of the custom field in a foreign system (ex: Zendesk).

string
length between 1 and 255

The name of the custom field.

enum

The type of the managed field.

string
enum

Type of entity on which to use this custom field.

Allowed:
integer

Order in which custom fields are displayed.

boolean

Whether this custom field is required.

Response

Updated 4 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago