Update customer

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

Overview

Update an existing customer's profile. You can modify contact information, marketing preferences, and metadata.

Example: A customer changes their email address. Update the customer with the new email value.


Behavior

  • metadata is merged with existing metadata, not replaced. To remove a key, set it to null.
  • Setting organization to null removes the customer from their organization.
  • Setting default_source_id updates the default payment method and syncs it.

Conditional Requirements

ConditionRequired Fields
password_type is setpassword
password is set without password_typeDefaults to password_bcrypt
default_source_id is setMust be a valid source belonging to this customer
Account has TAP payment gateway activeCannot set email, first_name, last_name, or phone to null/empty
Path Params
int32
required
Query Params
int32
required
Body Params
string
boolean
string
string
string
boolean
boolean
boolean
string
length ≤ 100
string
boolean
string
string
string
enum
Allowed:
string
length ≤ 100
string
string
string
string
enum
Allowed:
boolean
int32
boolean
string
metadata
object
Responses

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