Create User(s)

Allowed Scopes: experimental:user:manage

Create users in the company the token resolves to, and send each of them an invitation. Only active admins and account owners can perform this operation, and users can only be created with the requester or controller role.

Send an array of 1 to 50 users; a single object outside an array is rejected with a 400. Users are created one after the other, and a user that fails does not prevent the others from being created: each one gets its own outcome in items, in request order, also when the array has a single user.

Creating never updates an existing user. Retrying a request is safe: users created by an earlier attempt come back as emailUnavailable, without their id, so read them back with the list of users.

The whole request is refused, and nobody is created, when the company has no seat left for the users to create (409), or when it is churned or managed by an HRIS integration (403).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Array of users to create (1 to 50).

Array of users to create (1 to 50).

string
length ≥ 1

Name of an existing cost center of the company, set as the user default.

string
required

Work email of the user. It must not belong to any Spendesk user yet.

string
required
length ≥ 1
string
required
length ≥ 1
string

Email of an existing member of the company, set as the user manager.

string
enum

Role of the user in the company. Defaults to requester.

Allowed:
string
length ≥ 1

Name of an existing spending (approval) policy of the company.

Headers
string

ID of the company the request acts on. Required with an organisation-level token; not needed with a company-level token.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json