GOgorgias
Custom Fields

Create a custom field

Changed on
post/api/custom-fields

Request

Request body

external_idstring

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

object_type'Ticket' | 'Customer' required
labelstring required

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.

requirement_type'visible' | 'required' | 'conditional'
deactivated_datetimestring date-time

When the custom field was deactivated.

Example request

{
  "external_id": "custom-field-84203241",
  "label": "Test field",
  "description": "An amazing field description.",
  "priority": 1,
  "required": true,
  "definition": {
    "input_settings": {
      "placeholder": "Enter this here..."
    }
  },
  "deactivated_datetime": "2021-01-02T03:04:05.123456"
}

Response

The created custom field.

idinteger required

ID of the custom field.

external_idstring

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

object_type'Ticket' | 'Customer' required
labelstring required

The name of the custom field.

descriptionstring

The description of the custom field.

priorityinteger required

Order in which custom fields are displayed.

requiredboolean required

Whether this custom field is required.

requirement_type'visible' | 'required' | 'conditional' required
created_datetimestring date-time required

When the custom field was created.

updated_datetimestring date-time required

When the custom field was last updated.

deactivated_datetimestring date-time

When the custom field was deactivated.

Example response

{
  "id": 123,
  "external_id": "custom-field-84203241",
  "label": "Test field",
  "description": "An amazing field description.",
  "priority": 1,
  "required": true,
  "definition": {
    "input_settings": {
      "placeholder": "Enter this here..."
    }
  },
  "created_datetime": "2019-01-02T03:04:05.123456",
  "updated_datetime": "2020-01-02T03:04:05.123456",
  "deactivated_datetime": "2021-01-02T03:04:05.123456"
}

Changes

  • 3fdfcb5b6678Revision changes
    • info

      added the new optional request property

    • info

      added the required property to the response with the status