Start a create-or-update users job

Starts an initialized job to create or update users.

Start processing an initialized create-or-update users job. This is the second step in the asynchronous flow.

Call this endpoint after adding all your users through the Initialize create or update users job endpoint.

If the system encounters an error with a user record, it will still process all other user records. Once the job completes, an email with the results is sent to the user who started the job.

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.

Validation option

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

Path Params
string
required

The id of the job to start

Body Params
boolean

If this job should be validate only.

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 (as specified on InitCreateOrUpdateUsersJobRequest)

password_settings
object

Optional. Password settings for users in this job.

Responses

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