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

When the custom field was deactivated.

definition
required

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
required
length between 1 and 255

The name of the custom field.

enum

The type of the managed field.

string
enum
required

Type of entity on which to use this custom field.

Allowed:
0 to 5000

Order in which custom fields are displayed.

boolean
Defaults to false

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