Updating a customer

put

https://api.processout.com/customers/{customer_id}

You can update a Customer object that you have already created by modifying its data fields directly and then calling the save() function on the object. You would most likely update a customer's details after first fetching them from storage.

Path Params

customer_id

string

required

ID of your customer

Body Params

first_name

string

First name of the customer.
Maximum 80 characters long

last_name

string

Last name of the customer.
Maximum 80 characters long

string

Customer’s email address.
Must be a valid email

address1

string

First line of the customer’s address.
Maximum 80 characters long

address2

string

Second line of the customer’s address.
Maximum 80 characters long

city

string

City of the customer’s address.
Maximum 80 characters long

state

string

State or county of the customer’s address.
Maximum 80 characters long

zip

string

ZIP code of the customer’s address.
Maximum 16 characters long

country_code

string

Country code of the customer's address (US, FR...).
Must be a valid ISO 3166 country code with 2 characters

phone

object

Phone number of the customer.

legal_document

string

Legal document number (required in some countries).
Maximum 255 characters long; example for a CPF document in Brazil: 853.513.468-93

ip_address

string

IP address of the customer.
Must be a valid IPv4 or IPv6 address

sex

string

Sex of the customer. Can be male or female.

date_of_birth

date

Customer’s date of birth.
RFC1123 date or timestamp

is_business

boolean

Denotes whether or not the customer represents a business.

registered_at

date

Date when the customer was registered on your platform. This defaults to the same date as created_at if you omit it.
RFC1123 date or timestamp

Headers

Idempotency-Key

string

Unique key to your request that will be used for idempotency

Responses

200200

400400

401401

404404

4XX4XX