REST RPC APICustomers

Create

View as Markdown
Creates a new customer account.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
merchantstringRequired
Merchant ID
merchant_user_idstringRequired
Merchant User ID
session_idstringRequired

Session ID, obtained from og_session_id cookie.

user_token_idstringRequired
User Token ID
first_namestringRequired
Customer first name
last_namestringRequired
Customer last name
emailstringRequired
Customer email
phone_numberstringRequired
Customer phone number
phone_typestringRequired

Customer phone type: “invalid”, “landline”, “mobile”, or “voip”

livebooleanRequired

Account status: active = True

createdstringRequired
Date of account creation
last_updatedstringRequired
Date of last customer account update
last_loginstringRequired
Date of last customer account login
localeintegerRequired

Customer locale code. Accepts a locale string (e.g. "en-US") or an integer ID for backwards compatibility.

extra_datastringOptional

Raw JSON string that should be JSON.parse() as key/value store for any extra information.

experiencesstringOptional

Experience name and Boolean value as key/value store, formatted as raw JSON string, to be JSON.parse() on retrieval

price_codestringOptional
Customer price code

Response

200

Errors

400
Bad Request Error
403
Forbidden Error