Initialize a create-or-update users job

Creates a new job to create or update users and returns a job ID for later execution.

Initialize a create-or-update users job. This is the first step in the asynchronous flow.

The response includes a job_id, which you'll use to start the job using the Start create-or-update users job endpoint.

You can add up to 2000 users per request. For larger operations, call this endpoint again with the same job_id to add more users to 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.

Body Params
string

ID of the job to add users to, if this is the first request this is optional.

users
array of objects
users
Responses

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