Create and Update Users

POST /api/v1_1/users

post
Users

https://{domain}.customersuccessbox.com/api/v1_1/users
POST Users allow you to create and/or update a batch of users in a single request. Our recommendation for batch size is to limit each batch to a maximum of 200 records.
Request
Response
Request
Headers
Authorization
required
string
Bearer {api_key}
Content-Type
required
string
application/json
Body Parameters
user_id
required
string
Unique identifier for user
account_id
required
string
Unique identifier for account
Response
200: OK
{
"success": true
}

Body example

Refer to available fields in User Resource for attributes that can be set and updated for an Account using this call.

Only those fields are allowed which aren't marked as Read-only.

[{
"user_id": "fg127",
"account_id": "ACME343rq"
},
{
"user_id": "fg346",
"account_id": "ROBUSTO536fg"
},
{
"user_id": "fg234",
"account_id": "BREW536fg"
}]

CURL request example

curl --location --request POST "https://{domain}.customersuccessbox.com/api/v1_1/users" \
--header "Authorization: Bearer {api_key}" \
--header "Content-Type: application/json" \
--data "[{
\"user_id\": \"fg127\",
\"account_id\": \"ACME343rq\"
},
{
\"user_id\": \"fg346\",
\"account_id\": \"ROBUSTO536fg\"
},
{
\"user_id\": \"fg234\",
\"account_id\": \"BREW536fg\"
}]"