Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Customers

Update customer field value

Update a customer's custom field value.

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

Path parameters

customer_idinteger required

The ID of the customer.

idinteger required

The ID of the custom field.

Request body

string required
OR
integer required
OR
boolean required

Response

List of customer's updated custom fields values.

{"stackTrail":"components:schemas:CustomerCustomFieldWithValue:properties:value","oasType":"schema","type":"unknown","title":"value","description":"The value of the custom field for this particular customer."}

Example response

{
  "field": {
    "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"
  }
}