API Reference

Create a custom field

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

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

string
enum
required

Type of entity on which to use this custom field.

Allowed:
string
required
length between 1 and 255

The name of the custom field.

string
length between 0 and 1024

The description of the custom field.

integer
0 to 5000

Order in which custom fields are displayed.

boolean
Defaults to false

Whether this custom field is required.

managed ticket field type | managed customer field type

The type of the managed field.

definition
required

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

date-time

When the custom field was deactivated.

Response

Updated 18 days 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 18 days ago