Update Custom Field

Update a custom field

PUT/api/custom-fields/{id}

Use it in a workflow

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

Request

Path parameters

idintegerrequired

The ID of the custom field to update.

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_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.

deactivated_datetimestring (date-time)

When the custom field was deactivated.

json

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

Response

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

idinteger

ID of the custom field.