Update customer

put

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

Partially update the authenticated customer’s profile.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Overview

Update the authenticated customer. This is a partial update — send only the fields you want to change. Returns the updated customer and a fresh JWT.

Example: A customer edits their name in account settings. Send first_name and last_name; the response reflects the change.

📘
Changing the email
If you change email, email_confirm resets to false, and when email verification is enabled on the site a verification email is sent. See Email Verification.

Conditional Requirements

Condition	Required Fields
Account has an active TAP payment gateway	`first_name`, `last_name`, `phone`

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

string

length ≤ 255

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

length ≤ 100

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

length ≤ 100

A display name that can be used by the customer, the primary use case of this is for commenting systems.

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

length ≤ 255

The customer's organization.

phone

string

length between 5 and 20

The customer's phone number. Must be preformatted and contain only numbers.

phone_confirm

string

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

salutation

string

length ≤ 255

The customer's salutation.

title

string

length ≤ 255

The customer's title.

tin

string

The customer's tax identification number.

profile_photo

string | null

The customer’s profile photo.

Responses

Overview

Changing the email

Conditional Requirements

200Success.

400Invalid request.

401Unauthorized.

404Not found.