Update Customer

put

https://api.fera.ai/v3/private/customers/{id}

Update data for a specific customer.

Path Params

string

required

ID of the customer you want to update. External ID is also accepted here

Body Params

Object creation attributes.

external_id

string

required

string

required

Email address of the customer.

name

string

First, last and middle name of customer.

display_name

string

Public-safe name to display as defined in the customer's profile.

If this is not specified and the customer name is present then public API will use the store settings to generate a display name instead.

country_code

string

length ≤ 2

Country code where the customer is located.

region_name

string

State, province or region name (not the code).

zip

string

Zip, postal or region code of the customer.

display_location

string

Public-safe location to display on customer profile.

is_anonymous

boolean

If true, the customer's display name will be the word 'Anonymous'.

is_name_visible

boolean

Should the customer name be displayed? If not, 'Anonymous' will be displayed.

If true then the public API will return display_name or a generated name based on the store settings if none provided.

is_location_visible

boolean

Should the customer location be displayed?

If true then the public API will return display_location or a generated location based on the store settings if none provided.

avatar

file

Photo to use as the avatar image. This will replace the existing file if one exists. This can also be specified as a remote URL and Fera will download that file and store it on it's CDN. To upload a file, use multi-part form data with the 'avatar' key and the file contents (JSON POST can't upload files this way).

avatar_url

uri

Public-safe customer display picture (avatar) URL.

Responses

Language

Credentials

Response

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

application/json

202Successful response

404Not found error

422Validation error