Update a customer (merchant-scoped)

Update a customer's contact and address details.

Send at least one field. Trying to move the customer to another merchant or tenant (merchantId, tenantId, merchant_id or tenant_id) returns 400 VALIDATION_ERROR. A customer of another merchant returns 404.

Changes apply to future payments. Payments already made keep their link to the customer.

Merchant users work on their own merchant's customers. Tenant owners and admins can work on any merchant in their tenant by passing ?merchantId=. A merchant in another tenant returns 404. Other roles are refused.

Authenticate with a dashboard session token, or a merchant-pinned secret key in X-API-Key. A secret key acts only for its own merchant: anything it creates belongs to that merchant and records the key as the actor, and another merchant's customers return 404. Publishable, payout_write and agent_onboarding keys are refused.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

Resource identifier (UUID).

Query Params
uuid

Tenant admin/owner override — target merchant within the caller's tenant (UUID). Required for tenant_admin/tenant_owner; ignored for role merchant and for a secret key (scope comes from the credential).

Body Params

At least one field. Send null to clear an optional field. Changing companyName, firstName or lastName does not change name; send name too if it should follow.

string
length between 1 and 255
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null
string | null

ISO 3166-1 alpha-2 (e.g. US).

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json