API reference
- Getting Started with Your API
- SDKs and Toolkits
- Customer Overview
- POSTAdd Sales Rep To B2B Account
- DELRemove Sales Rep From B2B Account
- POSTAdd Sales Reps To B2B Account
- POSTAdd User
- POSTAdd User Role Async
- DELRemove User Role Async
- PUTAssign a role to a specific account
- DELRemove a role from a specific account.
- POSTChange Parent Account
- POSTCreate a new role and associate it with specified accounts.
- PUTDelete Account Priorities
- PUTEnable or disable role inheritance for future child accounts.
- GETGet Account Priorities
- GETGet Accounts by User
- GETGet Accounts For Sales Rep
- GETGet all roles available to the specified account
- GETGet B2B Account
- PUTUpdate Account
- GETGet B2B Account Attribute
- PUTUpdate B2B Account Attribute
- DELDelete B2B Account Attribute
- GETGet B2B Account Attributes
- POSTAdd B2B Account tAttribute
- GETGet B2B Account Hierarchy
- GETGet B2B Accounts
- POSTAdd Account
- GETGet Behaviors for b2b shopper
- GETGet role details by role ID, including associated account IDs
- PUTUpdate existing role and its account associations.
- DELDelete role and all its account associations.
- GETGet User Behaviors
- GETGet User Roles Async
- GETGet Users Async
- GETGet Users By Role
- GETGets all the behavior categories for the b2b shopper
- PUTRemove User
- PUTUpdate Account Priorities
- PUTUpdate B2B Account Status
- PUTUpdate Sales Reps On B2B Account
- PUTUpdate User
- PUTUpgrade B2C Accounts To B2B
Error
Copy
A valid request URL is required to generate request examplesCopy
{
"accountIds": [
123
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"behaviors": [
123
],
"id": 123,
"isSystemRole": true,
"name": "<string>"
}Create a new role and associate it with specified accounts.
Required fields:
- Name: Role name (must be unique within tenant)
- Behaviors: List of behavior IDs (at least one required)
- AccountIds: List of account IDs to associate with role (at least one required)
POST
/
commerce
/
customer
/
b2baccounts
/
roles
Error
Copy
A valid request URL is required to generate request examplesCopy
{
"accountIds": [
123
],
"auditInfo": {
"createBy": "<string>",
"createDate": "2023-11-07T05:31:56Z",
"updateBy": "<string>",
"updateDate": "2023-11-07T05:31:56Z"
},
"behaviors": [
123
],
"id": 123,
"isSystemRole": true,
"name": "<string>"
}Authorizations
JWT Authorization header using the Bearer scheme.
Query Parameters
limits which fields are returned in the response body
Body
application/json
Role payload containing name, behaviors, and accountIds
List of Account IDs associated with this role. Required for CreateRole and UpdateRole operations.
Show child attributes
Show child attributes
List of Role Behaviors
Unique Identifier for the Role
Indicate if the Role is a System Role or Custom Role
Name for the Role
Response
Success
List of Account IDs associated with this role. Required for CreateRole and UpdateRole operations.
Show child attributes
Show child attributes
List of Role Behaviors
Unique Identifier for the Role
Indicate if the Role is a System Role or Custom Role
Name for the Role
⌘I