Customers

Update customer profile

Partially updates a customer's profile. Send at least one of fullName, email, or phone; omitted fields are left unchanged. Unrecognised keys are ignored, and a body with none of the three recognised keys fails with 422. phone is validated against the customer's stored countryCode (it cannot be changed here) and stored in E.164 format.

patch/api/v1/customer/{customerId}

Request

Base URL
https://sandbox.api.afriex.com
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/afriex/apis/afriex-business-api/docs/api/v1/customer/:customerId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

customerIdstring required

The unique identifier of the customer

Request body

fullNamestring

The full name of the customer.

emailstring email

The email of the customer.

phonestring

The phone number of the customer. Must be valid for the customer's stored countryCode; saved in E.164 format.

Response

Customer updated successfully.

Changes

No recorded changes to this operation across all 1 revision of this API.