Website logo
SupportDashboardAbout SparkLayer
📘Help Docs
⚙️Tech Docs
🎆Ignite Docs
Navigate through spaces
⌘K
Overview
Platform Connection
Data Sync
Endpoints Overview
Authentication
Endpoints Reference
Platform Connection
Customer
Customer Sub-Accounts
Customer Address
Checkout
Data Sync
Authentication
Docs powered by Archbee
Endpoints Reference
Customer Sub-Accounts

Update an existing Customer sub-account

PATCH
/v1/{siteEnv}/{siteId}/sub-accounts/{customer_external_id}

Update the details of an existing customer sub-account. This allows changing the account's first name, last name and role. This does not allow for the email to be updated.

PATH PARAMETERS
siteEnv
string
*
Example: live
siteId
string
*
Example: bobs-store
customer_external_id
string
*
Platform ID of Customer
BODY PARAMETERS
body
object
*
first_name
string
Example: Bob
last_name
string
Example: Jones
role
string<main | limited-customer>
Example: limited-customer
A role that represents the users permissions
RESPONSES
201
Successful operation
400
Error handling request such as name too short
401
Auth Failure
500
System Exception




PREVIOUS
Create a new Customer sub-account
NEXT
Remove a Customer sub-account
Docs powered by Archbee