Skip to content
WhiteBeard

Register a new customer

POST
/cms/customer/register

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
email
string
password
string
name
string
fields
object
country_code
string
first_name
string
last_name
string
gender
string
country
string
city
string
active
integer
address
object
preferredLanguage
string
send_activation_email

Set to 1 to send activation email upon registration. Otherwise, customer will be activated automatically.

integer

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Customer created

object
customer
Customer

API representation of a customer (Visitor)

object
userId

User ID

string format: int64
displayName

Display name

string
loginName

Login name (email)

string
photo

Photo URL

string
country_code

Country code

string
preferences

Preferences

object
country

Country

string
city

City

string
mobile

Mobile number

string
dateOfBirth

Date of birth

string format: date
user_type

User type

string
creationDate

Creation date

string format: date-time
archiveCredits

Archive credits

subscriptions

Subscriptions

Array<object>
Subscription

API representation of a customer subscription

object
id

Subscription ID

activationDate

Activation date

string format: date-time
deactivationDate

Deactivation date

string format: date-time
userId

User ID

status

Status

integer
purchased_item
One of:
Product Item

API representation of an ecommerce product item

object
id

Item ID

description

Description

string
productId

Product ID

product

Product name

string
price

Price

currency

Currency

string
available

Available

item_order

Item order

shippable

Shippable

weight

Weight

installments

Installments

oncePerUser

Once per user

isUpgrade

Is upgrade

upgradeType

Upgrade type

string
upgradeFrom

Upgrade from

string
upgradeExcludeItems

Upgrade exclude items

string
upgradePriceWeb

Upgrade price web

upgradePriceMobile

Upgrade price mobile

settings

Settings

object
hasImage

Has image

additional_label_1

Additional label 1

string
additional_label_2

Additional label 2

string
additional_label_3

Additional label 3

string
diameter

Diameter

length

Length

depth

Depth

width

Width

recurrent

Recurrent

recurrentPrice

Recurrent price

recurrentStart

Recurrent start

string
recurrentSchedule

Recurrent schedule

string
sku

SKU

string
prices

Prices

object
stock_enabled

Stock enabled

stock_available

Stock available

packageQuantity

Package quantity

relatedItems

Related items

Array<object>
object
images

Images

Array<string>
files

Files

Array<string>
product_details

Product details. Deprecated to avoid circular references. Use productId instead.

object
translations

Translations

Example
{
  "en": {
    "name": "Name",
    "subtitle": "Subtitle"
  },
  "fr": {
    "name": "Nom",
    "subtitle": "Sous-titre"
  }
}
actionData

Action data to be executed when a product item is bought

Array<object>
object
function
string
Example
registerSubscription
param
string
Example
365
group
string
Example
subscription
Example
[
  {
    "function": "registerSubscription",
    "param": "365",
    "group": "subscription"
  }
]
actionDataRenew

Action data to be executed when a product item is bought as a renewal

Array<object>
object
function
string
Example
registerSubscription
param
string
Example
365
group
string
Example
subscription
Example
[
  {
    "function": "registerSubscription",
    "param": "365",
    "group": "subscription"
  }
]
nextRenewal

Next renewal date

string format: date-time
lastFailedOrder

Last failed order ID

attempts

Attempts

integer
referenceOrderId

Reference order ID

group

Group code

string
group_name

Group name

string
paymentMethod

Payment method

string
cancellationRequestDate

Cancellation request date

string format: date-time
nullable
cancellationReason

Cancellation reason

string
nullable
cancellationReasonCustom

Cancellation reason (custom user text)

string
nullable
currency

Currency

string
active

Active status

integer
clientId

Client ID

fields

Fields

object
tags

Tags assigned to this customer

Array<integer>
segments

Segments this customer is part of

Array<integer>
email_channels

Channels (E-mail lists) this customer is subscribed to

Array<object>
object
channelId

Channel ID

integer
timestamp

Timestamp of subscription

string format: date-time
push_subscriptions

Push notification subscriptions for all customer devices

Array<object>
object
channelId

Channel ID

integer
timestamp

Timestamp of subscription

string format: date-time
token

Push token

string
clientOs

Device type (e.g., ios, android, web)

string
clientOsVersion

Device OS version (e.g., 14.4, 11.0)

string
userAgent

User agent string

string
clientVersion

Client version (e.g., 1.0.0)

string
token
object