Endpoints Reference
Customer Sub-Accounts
Create a new Customer sub-account
POST
/v1/{siteEnv}/{siteId}/sub-accounts
PATH PARAMETERS
siteEnv
string
*Example: live
siteId
string
*Example: bobs-store
BODY PARAMETERS
body
object
*email
string<email>
*Example: bob@sparklayer.io
first_name
string
*Example: Bob
last_name
string
*Example: Jones
parent_customer_external_id
string
*Example: CU1234
Parent Customer ID of the Customer
role
string<main | limited-customer>
Example: limited-customer
A role that represents the users permissions
RESPONSES
201
Successful operation
object
customer_external_id
string
Example: CU1234
Platform ID of Customer
400
Error handling request such as email already taken
object
error_code
string<email-already-taken>
Example: email-already-taken
Machine-readable error code such as email already taken
401
Auth Failure
500
System Exception