Create an invited user

post

https://app.360learning.com/api/v2/users

Required OAuth scope: users:write.

Creates a new user account with the invited status. If a user with the same 'mail' or 'username' was previously deleted, this operation will restore their account to an invited status.

If 'mail' is provided, the user receives an invitation email upon creation to activate their account, along with other emails. The account can also be activated via the 'Activate a user' endpoint. If 'sendInvitationEmail' is set to false, the user will not receive the invitation email, but may still receive other emails.

Query Params

sendInvitationEmail

string

enum

If true (or not provided), the invitation email is sent to the created user. If false, the invitation email is not sent.

Allowed:

Body Params

mail

string

length ≥ 1

The email address of the user. If not given, username must be given.

username

string

length ≥ 1

The username that can be used to log in if the company allows it. If not given, mail must be given.

membership

object

required

The initial group membership of the user.

primaryGroupId

string

The unique ID of the primary group of the user.

custom

string

length ≥ 1

The value of the Additional information field in the user’s profile. This is not the value of the custom fields associated with the user.

firstName

string

length ≥ 1

The first name of the user.

lastName

string

length ≥ 1

The last name of the user.

job

string

length ≥ 1

The role title of the user.

lang

string

enum

The default language of the user, in a bigram format (en, fr, de, etc.). Default: en.

organization

string

length ≥ 1

The organization that the user belongs to.

phone

string

length ≥ 1

The phone number of the user.

toBeDeactivatedAt

date-time

The date and time when the user will be deactivated, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

Headers

360-api-version

string

enum

required

The version of the API.

Allowed:

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Returns the previously deleted user, who has been successfully restored to an invited status.

201Returns newly created invited user.

400The server cannot or will not process the request due to something that is perceived to be a client error.

401The given access token is either missing, invalid, has expired, or has been revoked.

403The given access token does not have the required OAuth scope to execute the request.

404The given groupId does not correspond to any existing group.

429The client has sent too many requests in a short amount of time.