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
string

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

string
enum

Type of entity on which to use this custom field.

Allowed:
string
length between 1 and 255

The name of the custom field.

string
length between 0 and 1024

The description of the custom field.

integer

Order in which custom fields are displayed.

boolean

Whether this custom field is required.

managed ticket field type | managed customer field type

The type of the managed field.

definition

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

date-time

When the custom field was deactivated.

Response

Updated 2 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 2 months ago