Create or update users synchronously

Performs bulk user creation or updates synchronously and returns the results in real time.

Create or update up to 10 users in a single request and receive results immediately, including the created users' IDs.

For larger operations, use the asynchronous flow.

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.

Error handling

If the system encounters an error with a user record, it will still process all other user records.

The response will include any validation or processing errors. See bulk user operations errors for details on error codes and meanings.

Validation option

Set the validate_only parameter to true to validate your data without making any changes.

Body Params
users
array of objects
required
users*
boolean

Only validate the data, don't apply the changes.

email_settings
object

Optional. Email settings for new users that are created - defaults to sending an email if not provided.
Overwritten by more specific EmailSettings on the individual user

Responses

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