younifyd
Menu

Create Custom Field

Create a custom field

POST/api/custom-fields

Use it in a workflow

  1. Add a step and choose the Gorgias connector.
  2. Pick the Create Custom Field action (under Custom Fields).
  3. Fill in the fields below, then reference the result from later steps as {{createCustomField.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

external_idstring

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

object_typestringrequired

One ofTicketCustomer

labelstringrequired

The name of the custom field.

descriptionstring

The description of the custom field.

priorityinteger

Order in which custom fields are displayed.

requiredboolean

Whether this custom field is required.

Default false

managed_typeoneOf

The type of the managed field.

definitiononeOfrequired

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

deactivated_datetimestring (date-time)

When the custom field was deactivated.

json
{
  "object_type": "Ticket",
  "label": "string",
  "definition": null,
  "external_id": "string",
  "description": "string",
  "priority": 0,
  "required": false,
  "managed_type": null,
  "deactivated_datetime": "2025-01-01T00:00:00Z"
}

Response

Returns 201 with an object. Read it in later steps with {{createCustomField.response.data.<field>}}.

idinteger

ID of the custom field.

external_idstring

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

object_typestring

One ofTicketCustomer

labelstring

The name of the custom field.

descriptionstring

The description of the custom field.

priorityinteger

Order in which custom fields are displayed.

requiredboolean

Whether this custom field is required.

managed_typeoneOf

The type of the managed field.

definitiononeOf

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

created_datetimestring (date-time)

When the custom field was created.

updated_datetimestring (date-time)

When the custom field was last updated.

deactivated_datetimestring (date-time)

When the custom field was deactivated.

json
{
  "id": 0,
  "object_type": "Ticket",
  "label": "string",
  "priority": 0,
  "required": false,
  "definition": null,
  "created_datetime": "2025-01-01T00:00:00Z",
  "updated_datetime": "2025-01-01T00:00:00Z",
  "external_id": "string",
  "description": "string",
  "managed_type": null,
  "deactivated_datetime": "2025-01-01T00:00:00Z"
}

Need more? See the Gorgias guide for connection setup and behaviour shared by every action.