younifyd
Menu

Update Customer Custom Field Value

Update customer field value

PUT/api/customers/{customer_id}/custom-fields/{id}

Use it in a workflow

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

Request

Path parameters

customer_idintegerrequired

The ID of the customer.

idintegerrequired

The ID of the custom field.

Response

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

fieldobject
idintegerrequired

ID of the custom field.

external_idstringrequired

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

object_typestringrequired

One ofTicketCustomer

labelstringrequired

The name of the custom field.

descriptionstringrequired

The description of the custom field.

priorityintegerrequired

Order in which custom fields are displayed.

requiredbooleanrequired

Whether this custom field is required.

managed_typestringrequired

One ofcustomer_type

definitiononeOfrequired

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

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)required

When the custom field was deactivated.

valueany

The value of the custom field for this particular customer.

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

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