Update customer

put

https://www.pelcro.com/api/v1/sdk/customer

Update a customer on-session.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

string

The customer's email address. If customer used social login or is a member of any group subscriptions, changing email is not allowed.

username

string

The customer's username. Must contain only alpha-numeric characters, dashes or underscores, as well as being unique under the same account.

display_name

string

The customer's display name.

email_confirm

boolean

A boolean on whether the customer's email address was confirmed.

email_hardbounce

boolean

A boolean on whether the customer's email is hardbounce.

first_name

string

The customer's first name. Always required if active payment gateway is tap.

last_name

string

The customer's last name. Always required if active payment gateway is tap.

metadata

array of objects

Set of key-value pairs that can be saved on customer level. This can be useful for storing additional information about the object in a structured format.

metadata

organization

string

The customer's organization.

phone

string

The customer's phone number. Must be preformatted and contain only numbers (length min: 5, length max: 20).

phone_confirm

string

A boolean on whether the customer's phone was confirmed.

salutation

string

The customer's salutation.

title

string

The customer's title.

tin

string

The customer's tax identification number.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Responses

Language

Credentials

Query

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400

401401