BigCommerce Docs

curl -X POST https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/users/bulk_create \
     -H "authToken: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "code": 200,
  "data": {
    "failedItems": [],
    "successfulItems": [
      {
        "customerId": 2,
        "email": "user1@example.com",
        "firstName": "Jane",
        "lastName": "Smith",
        "phone": "555-123-4567",
        "userRole": 1
      },
      {
        "customerId": 2,
        "email": "user2@example.com",
        "firstName": "John",
        "lastName": "Doe",
        "phone": "555-987-6543",
        "userRole": 1
      }
    ]
  },
  "message": "Success"
}

Create company users in batch

Authentication

authTokenstring

API Key authentication via header

Path parameters

companyIdstringRequired

Request

Request body

acceptWelcomeEmailenumOptional

(0=will not receive email 1=will receive email)

Allowed values:

userslist of objectsOptional

Response

Response Success

codedouble

Response status code

dataobject

Response data

messagestring

Response message

Errors

400

Bad Request Error

404

Not Found Error

Bulk Create Company User

Bulk Create Company User

Authentication

Path parameters

Headers

Request

Response

Errors

Authentication

Path parameters

Headers

Request

Response

Errors

$	curl -X POST https://api-b2b.bigcommerce.com/api/v2/io/companies/companyId/users/bulk_create \
>	-H "authToken: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"code": 200,
3	"data": {
4	"failedItems": [],
5	"successfulItems": [
6	{
7	"customerId": 2,
8	"email": "user1@example.com",
9	"firstName": "Jane",
10	"lastName": "Smith",
11	"phone": "555-123-4567",
12	"userRole": 1
13	},
14	{
15	"customerId": 2,
16	"email": "user2@example.com",
17	"firstName": "John",
18	"lastName": "Doe",
19	"phone": "555-987-6543",
20	"userRole": 1
21	}
22	]
23	},
24	"message": "Success"
25	}