---
updatedAt: 2026-04-20T19:43:50.000Z
agentTools:
  projectIndex: https://developers.gorgias.com/llms.txt
---

# Update customer field value

Update a customer's custom field value.

# OpenAPI definition

```json
{
  "security": [
    {
      "basicAuth": []
    }
  ],
  "info": {
    "description": "The Gorgias REST API. Please go to https://developers.gorgias.com for more details.",
    "title": "Gorgias REST API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://{domain}.gorgias.com",
      "variables": {
        "domain": {
          "default": "your-domain"
        }
      }
    }
  ],
  "x-readme": {
    "proxy-enabled": false
  },
  "paths": {
    "/api/customers/{customer_id}/custom-fields/{id}": {
      "put": {
        "summary": "Update customer field value",
        "operationId": "update-customer-custom-field-value",
        "description": "Update a customer's custom field value.",
        "parameters": [
          {
            "in": "path",
            "name": "customer_id",
            "description": "The ID of the customer.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "in": "path",
            "name": "id",
            "description": "The ID of the custom field.",
            "required": true,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "oneOf": [
                  {
                    "type": "string"
                  },
                  {
                    "type": "integer"
                  },
                  {
                    "type": "boolean"
                  }
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "List of customer's updated custom fields values.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CustomerCustomFieldWithValue"
                }
              }
            }
          }
        },
        "tags": [
          "Customers"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Customers"
    }
  ],
  "openapi": "3.1.0",
  "components": {
    "schemas": {
      "BooleanDataTypeDefinition": {
        "additionalProperties": false,
        "properties": {
          "data_type": {
            "const": "boolean",
            "enum": [
              "boolean"
            ],
            "title": "data  type",
            "type": "string"
          },
          "input_settings": {
            "description": "The input settings for this custom field, dependent on the input type.",
            "discriminator": {
              "mapping": {
                "dropdown": "#/components/schemas/BooleanDropdownInputSettings"
              },
              "propertyName": "input_type"
            },
            "examples": [
              {
                "choices": [
                  true,
                  false
                ]
              }
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/BooleanDropdownInputSettings"
              }
            ],
            "title": "input  settings"
          }
        },
        "required": [
          "data_type",
          "input_settings"
        ],
        "title": "boolean data type definition",
        "type": "object"
      },
      "BooleanDropdownInputSettings": {
        "additionalProperties": false,
        "properties": {
          "input_type": {
            "const": "dropdown",
            "enum": [
              "dropdown"
            ],
            "title": "input  type",
            "type": "string"
          },
          "choices": {
            "default": [
              true,
              false
            ],
            "description": "The boolean choices to show as a dropdown.",
            "examples": [
              [
                true,
                false
              ]
            ],
            "items": {
              "type": "boolean"
            },
            "title": "choices",
            "type": "array"
          },
          "default": {
            "description": "The default value.",
            "title": "default",
            "type": "boolean"
          }
        },
        "required": [
          "input_type"
        ],
        "title": "boolean dropdown input settings",
        "type": "object"
      },
      "CustomerCustomField": {
        "additionalProperties": false,
        "properties": {
          "id": {
            "description": "ID of the custom field.",
            "examples": [
              123
            ],
            "title": "id",
            "type": "integer"
          },
          "external_id": {
            "description": "ID of the custom field in a foreign system (ex: Zendesk).",
            "examples": [
              "custom-field-84203241"
            ],
            "title": "external  id",
            "type": "string"
          },
          "object_type": {
            "$ref": "#/components/schemas/ObjectType",
            "description": "Type of entity on which to use this custom field.",
            "examples": [
              "Customer"
            ]
          },
          "label": {
            "description": "The name of the custom field.",
            "examples": [
              "Test field"
            ],
            "maxLength": 255,
            "minLength": 0,
            "title": "label",
            "type": "string"
          },
          "description": {
            "description": "The description of the custom field.",
            "examples": [
              "An amazing field description."
            ],
            "title": "description",
            "maxLength": 255,
            "minLength": 0,
            "type": "string"
          },
          "priority": {
            "description": "Order in which custom fields are displayed.",
            "examples": [
              1
            ],
            "minimum": 0,
            "title": "priority",
            "type": "integer"
          },
          "required": {
            "description": "Whether this custom field is required.",
            "examples": [
              true
            ],
            "title": "required",
            "type": "boolean"
          },
          "managed_type": {
            "description": "The type of the managed field.",
            "examples": [
              "contact_reason"
            ],
            "$ref": "#/components/schemas/ManagedCustomerFieldType"
          },
          "definition": {
            "description": "The settings for this custom field, dependent on the data type.",
            "discriminator": {
              "mapping": {
                "boolean": "#/components/schemas/BooleanDataTypeDefinition",
                "number": "#/components/schemas/NumberDataTypeDefinition",
                "text": "#/components/schemas/TextDataTypeDefinition"
              },
              "propertyName": "data_type"
            },
            "oneOf": [
              {
                "$ref": "#/components/schemas/TextDataTypeDefinition"
              },
              {
                "$ref": "#/components/schemas/NumberDataTypeDefinition"
              },
              {
                "$ref": "#/components/schemas/BooleanDataTypeDefinition"
              }
            ],
            "title": "definition"
          },
          "created_datetime": {
            "description": "When the custom field was created.",
            "examples": [
              "2019-01-02T03:04:05.123456"
            ],
            "title": "created  datetime",
            "format": "date-time",
            "type": "string"
          },
          "updated_datetime": {
            "description": "When the custom field was last updated.",
            "examples": [
              "2020-01-02T03:04:05.123456"
            ],
            "title": "updated  datetime",
            "format": "date-time",
            "type": "string"
          },
          "deactivated_datetime": {
            "description": "When the custom field was deactivated.",
            "examples": [
              "2021-01-02T03:04:05.123456"
            ],
            "title": "deactivated  datetime",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "id",
          "external_id",
          "object_type",
          "label",
          "description",
          "priority",
          "required",
          "managed_type",
          "definition",
          "created_datetime",
          "updated_datetime",
          "deactivated_datetime"
        ],
        "title": "customer custom field",
        "type": "object"
      },
      "DropdownInputSettingsSettings": {
        "additionalProperties": false,
        "properties": {
          "input_type": {
            "const": "dropdown",
            "enum": [
              "dropdown"
            ],
            "title": "input  type",
            "type": "string"
          },
          "choices": {
            "description": "The available choices to show in the dropdown.",
            "items": {
              "type": "string"
            },
            "maxItems": 2000,
            "title": "choices",
            "type": "array"
          },
          "default": {
            "type": "string",
            "description": "The default value for this dropdown.",
            "title": "default"
          }
        },
        "required": [
          "input_type",
          "choices"
        ],
        "title": "dropdown input settings settings",
        "type": "object"
      },
      "ManagedCustomerFieldType": {
        "const": "customer_type",
        "enum": [
          "customer_type"
        ],
        "title": "managed customer field type",
        "type": "string"
      },
      "NumberDataTypeDefinition": {
        "additionalProperties": false,
        "properties": {
          "data_type": {
            "const": "number",
            "enum": [
              "number"
            ],
            "title": "data  type",
            "type": "string"
          },
          "input_settings": {
            "description": "The input settings for this custom field, dependent on the input type.",
            "discriminator": {
              "mapping": {
                "input_number": "#/components/schemas/NumberInputSettings"
              },
              "propertyName": "input_type"
            },
            "examples": [
              {
                "max": "130",
                "min": "120.5",
                "placeholder": "Enter this here..."
              }
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/NumberInputSettings"
              }
            ],
            "title": "input  settings"
          }
        },
        "required": [
          "data_type",
          "input_settings"
        ],
        "title": "number data type definition",
        "type": "object"
      },
      "NumberInputSettings": {
        "additionalProperties": false,
        "properties": {
          "input_type": {
            "const": "input_number",
            "enum": [
              "input_number"
            ],
            "title": "input  type",
            "type": "string"
          },
          "placeholder": {
            "description": "A hint to show within the input field when no data is entered.",
            "examples": [
              "Enter this here..."
            ],
            "title": "placeholder",
            "maxLength": 1024,
            "minLength": 0,
            "type": "string"
          },
          "min": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "string"
              }
            ],
            "description": "Minimum allowed number as value.",
            "examples": [
              "120.5"
            ],
            "title": "min"
          },
          "max": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "string"
              }
            ],
            "description": "Maximum allowed number as value.",
            "examples": [
              "130"
            ],
            "title": "max"
          }
        },
        "required": [
          "input_type"
        ],
        "title": "number input settings",
        "type": "object"
      },
      "ObjectType": {
        "enum": [
          "Ticket",
          "Customer"
        ],
        "title": "object type",
        "type": "string"
      },
      "TextDataTypeDefinition": {
        "additionalProperties": false,
        "properties": {
          "data_type": {
            "const": "text",
            "enum": [
              "text"
            ],
            "title": "data  type",
            "type": "string"
          },
          "input_settings": {
            "description": "The input settings for this custom field, dependent on the input type.",
            "discriminator": {
              "mapping": {
                "dropdown": "#/components/schemas/DropdownInputSettingsSettings",
                "input": "#/components/schemas/TextInputSettings"
              },
              "propertyName": "input_type"
            },
            "examples": [
              {
                "placeholder": "Enter this here..."
              }
            ],
            "oneOf": [
              {
                "$ref": "#/components/schemas/TextInputSettings"
              },
              {
                "$ref": "#/components/schemas/DropdownInputSettingsSettings"
              }
            ],
            "title": "input  settings"
          }
        },
        "required": [
          "data_type",
          "input_settings"
        ],
        "title": "text data type definition",
        "type": "object"
      },
      "TextInputSettings": {
        "additionalProperties": false,
        "properties": {
          "input_type": {
            "const": "input",
            "enum": [
              "input"
            ],
            "title": "input  type",
            "type": "string"
          },
          "placeholder": {
            "description": "A hint to show within the input field when no data is entered.",
            "examples": [
              "Enter this here..."
            ],
            "title": "placeholder",
            "maxLength": 1024,
            "minLength": 0,
            "type": "string"
          }
        },
        "required": [
          "input_type"
        ],
        "title": "text input settings",
        "type": "object"
      },
      "CustomerCustomFieldWithValue": {
        "additionalProperties": false,
        "properties": {
          "field": {
            "$ref": "#/components/schemas/CustomerCustomField",
            "description": "The custom field on which the value is set."
          },
          "value": {
            "description": "The value of the custom field for this particular customer.",
            "title": "value"
          }
        },
        "required": [
          "field",
          "value"
        ],
        "title": "customer custom field with value",
        "type": "object"
      }
    },
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "The username will be the email address of your Gorgias account and the password will be your API key."
      }
    }
  }
}
```