Bulk Add Users

This API requires the Account Administrator role.

Bulk adds Users using the file provided. The following file formats are supported:

  • .xlsx

The following fields must be unique otherwise a HTTP 409 Conflict will be returned:

  • jobName

Will trigger an asynchronous job, the status of which should be monitored via /jobs/{jobId}.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Query Params
string
length between 1 and 255
^[\p{L}\p{M}\p{N}\p{IsKatakana}0-9]+[\s\p{L}\p{M}\p{N}\p{IsKatakana}0-9\-\[\]\\_\.\+\*\'\"\!\|\(\)\{\}\;\:\,\^\+\<\>\&\£\@\$\¥\€\`\~\?\#\%\=]*$

Optional, job name that can be provided to uniquely identify the job.

Body Params
file
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json