Skip to main content

updateCustomerAttributes

Update or remove custom attribute values on a customer.

Business Rules​

  • Each entry names its value by row id or by the definition's handle.
  • A value is required unless the entry sets delete: true.
  • Removing a value archives it and leaves the definition untouched.

Error Scenarios​

  • **BAD_REQUEST**: the customer does not belong to this company; the list is empty; an entry names neither an id nor a handle; the value or the definition does not exist; the value belongs to another customer; or a value is blank without delete: true.

Permissions Required​

  • customers:update_attribute permission.
updateCustomerAttributes(
  input: UpdateCustomerAttributesInput!
): UpdateCustomerAttributesPayload

Arguments​

updateCustomerAttributes.input ● UpdateCustomerAttributesInput! non-null input common​

Parameters for UpdateCustomerAttributes

Type​

UpdateCustomerAttributesPayload object common​

Autogenerated return type of UpdateCustomerAttributes.