Create a user

SafetyCulture sends the new user a notification email after the user is added. If you don't set a password, the user receives an email to activate their account and set a password.

  • If the user previously existed in the organization and was deactivated or removed, SafetyCulture sends the user a reactivation email.
  • If the user already exists in SafetyCulture, any password provided in the request is ignored. The user can still log in with their existing password.

New users may take a few seconds to appear in responses from other endpoints, such as List group or organization users.

📘

Each API token is scoped to a single organization. If your account belongs to multiple organizations, use the token for the specific organization you want to add the user to.

Requirements

📘

Seat availability and billing

This feature is currently in Early Access. If your organization is enrolled, SafetyCulture automatically purchases additional paid seats when your seat limit is reached during user provisioning.

  • Users are provisioned with the correct seat type.
  • Your billing admin receives a summary email for any paid seats purchased automatically.
  • Your next invoice will include a prorated charge for the seats purchased from the date they were added.

Monitor your seat allocation regularly in the SafetyCulture web app to stay on top of your plan. Contact your customer success manager if you have any questions.

For adding several users at once, use the bulk user operations endpoints.

Body Params

The parameters for AddUser

The parameters for AddUser

string
required

The first name of the user.

string
required

The last name of the user.

string
required

The email address of the user.

string
required

The password of the user.

string

Message passed to the newly created user.

string
enum
Defaults to full

The billing seat type of the added user, free or full.

Allowed:
Responses

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