Skip to main content
PATCH
/
api
/
v1
/
customers
/
{id}
curl -X PATCH "https://api-sandbox.paywithsoap.com/api/v1/customers/cus_A3GuXEbThpqk2t6UTxEuoceVJyUEAX7V" \
  -H "Authorization:  YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jane",
    "phone_number": "5551234567"
  }'

{
  "id": "cus_A3GuXEbThpqk2t6UTxEuoceVJyUEAX7V",
  "internal_id": "cust_123",
  "email": "customer@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone_number": "5551234567",
  "date_of_birth": "1990-01-01",
  "created_at": "2025-03-10T16:08:14.427Z",
  "updated_at": "2025-03-12T09:15:42.001Z"
}
Update the details of an existing customer, such as correcting a misspelled name or refreshing an email or phone number that has changed. Identify the customer by the Soap customer_id (the cus_ id returned when the customer was created) in the URL. Since this is a PATCH request, only the fields you include in the request body are changed, and any fields you leave out keep their current values. Updates are always scoped to the customer belonging to the merchant whose API key is used.
At least one updatable field (first_name, last_name, email, phone_number, date_of_birth) must be provided, and any unrecognized field will cause the request to be rejected.
curl -X PATCH "https://api-sandbox.paywithsoap.com/api/v1/customers/cus_A3GuXEbThpqk2t6UTxEuoceVJyUEAX7V" \
  -H "Authorization:  YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Jane",
    "phone_number": "5551234567"
  }'

{
  "id": "cus_A3GuXEbThpqk2t6UTxEuoceVJyUEAX7V",
  "internal_id": "cust_123",
  "email": "customer@example.com",
  "first_name": "Jane",
  "last_name": "Doe",
  "phone_number": "5551234567",
  "date_of_birth": "1990-01-01",
  "created_at": "2025-03-10T16:08:14.427Z",
  "updated_at": "2025-03-12T09:15:42.001Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
id
string
required

Unique Soap identifier of the customer to update (the cus_ id returned at creation).

Example:

"cus_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK"

Body

application/json

At least one updatable field must be present. Unknown fields are rejected.

​
email
string<email>

Email address of the customer. Must be unique within your business.

Example:

"john@acme.com"

​
first_name
string
Example:

"John"

​
last_name
string
Example:

"Doe"

​
phone_number
string

Phone number of the customer in ISO 8601 format (10 digits, no hyphens, no country code). Must be unique within your business.

Example:

"8008001234"

​
date_of_birth
string<date>

Date of birth of the customer in ISO 8601 format (YYYY-MM-DD)

Example:

"1990-01-01"

Response

Customer updated.

​
id
string

Unique identifier for the customer to be used for future transactions.

Example:

"cus_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK"

​
internal_id
string
Example:

"3f1b8c4e-7c2e-4c2c-8d2f-179cf0efb36b"

​
email
string
Example:

"john@acme.com"

​
first_name
string
Example:

"John"

​
last_name
string
Example:

"Doe"

​
phone_number
string
Example:

"8008001234"

​
date_of_birth
string<date>
Example:

"1990-01-01"

​
created_at
string<date-time>
Example:

"2025-03-05T18:26:43.069Z"

​
updated_at
string<date-time>
Example:

"2025-03-10T16:08:14.427Z"