v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

Customers

Update customer custom fields

put/v3/customers/{id}/custom-field

Path parameters

idstring required

Example:123e4567-e89b-12d3-a456-426614174000

Customer Id

Request body

manufacturerCustomFieldIdstring

Manufacturer custom field ID. Required when isPurchaseOrder is not true.

customFieldValuestring required

Custom field value. For purchase order entries (isPurchaseOrder: true), this is the new PO number. Pass an empty string to unset the PO. Max 48 characters apply to PO values.

isPurchaseOrderboolean

Set to true to update the customer's active purchase order instead of a manufacturer-defined custom field. When true, manufacturerCustomFieldId is ignored and customFieldValue is used as the PO number.

Example request

[
  {
    "manufacturerCustomFieldId": "123e4567-e89b-12d3-a456-426614174000",
    "customFieldValue": "Sales"
  }
]

Response

Updated customer custom field