Update customer

put

https://www.pelcro.com/api/v1/core/customers/{id}

Update an existing customer.

Path Params

int32

required

The unique identifier of the customer.

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

string

The customer's email address, which must be valid and under the same account. The email format is validated against RFC standards and DNS validations are performed to ensure it is deliverable.

skip_email_dns_validations

boolean

When set, the DNS validations performed on the email address are skipped.

first_name

string

The customer's first name. If provided, must be a string containing a maximum of 255 characters.

last_name

string

The customer's last name. If provided, must be a string containing a maximum of 255 characters.

phone

string

Customer phone number. Non-numeric characters are stripped. Resulting digits must be between 5 and 20.

tele_marketing

boolean

Whether the customer has authorized receiving telemarketing communications.

mail_marketing

boolean

Whether the customer has authorized receiving email marketing communications.

email_hardbounce

boolean

A boolean on whether delivery attempts on the customer's email address result in permanent failures (ie: hard bounces).

display_name

string

length ≤ 100

The customer's display name. If provided, must be a string containing a maximum of 100 characters. If email is not provided, either this attribute or old_provider_id is required.

organization

string

The customer's organization. If provided, must be a string containing a maximum of 255 characters.

is_imported

boolean

Whether this customer was imported from an external system.

tin

string

The customer's tax identification number.

password

string

The customer password. If provided, must match the password_bcrypt algorithm format by default, unless specified otherwise via password_type attribute.

password_type

string

enum

The algorithm used on the provided password string. One of: plain_text, password_bcrypt, md5, drupal_v8.2.x, bcrypt_wordpress, crypt.

Allowed:

username

string

length ≤ 100

The customer's username. If provided, must be a string containing a maximum of 100 alpha-numeric characters in the ASCII range (0-9, a-z, A-Z), dashes or underscores.

title

string

The customer's title. If provided, must be a string containing a maximum of 255 characters.

salutation

string

The customer's salutation. If provided, must be a string containing a maximum of 255 characters.

timezone

string

The customer's time zone. If provided, must be a valid identifier or alias, see list of supported values.

language

string

enum

The customer's language as a two-letter code, defined by ISO 639-1 standard.

Allowed:

import_payment_methods

boolean

A boolean on whether to import payment methods stored on the current payment gateway provider for this customer.

This capability is only available for accounts having an active stripe payment gateway.

default_source_id

int32

The unique identifier of the payment method to set as default for this customer.

email_confirm

boolean

When true, marks the customer's email as verified (skips email confirmation flow).

billing_email

string

The customer's billing email.

metadata

object

Set of key-value pairs for storing additional information. Existing keys not included in the request are preserved. To delete a key, set its value to null.

Responses

200Success.

400Invalid request.

401Unauthenticated.

404Not found.