Customers
Update Customer
Update details of an existing customer profile, such as name, phone, or custom metadata.
PATCH
TypeScript SDK
Authorizations
Authenticate requests using your standard bearer API key (e.g. YOUR_API_KEY).
Path Parameters
Customer ID
Example:
"user_123"
Body
application/json
The customer friendly full name
Maximum string length:
100Example:
"John Doe"
The customer telephone/phone number
Maximum string length:
30Example:
"+1234567890"
The username of the customer (e.g. Discord, Whop)
Maximum string length:
100Example:
"johndoe"
Custom key-value metadata associated with the customer
Example:
{ "customKey": "customValue" }Response
200 - application/json
Customer updated successfully.
Response message indicating the outcome of the action.
Example:
"Customer updated successfully"
Previous
Generate Shared InviteGenerate a short-lived token granting temporary customer self-service billing page access.
Next
TypeScript SDK