JUjumpcloud
Bulk Job Requests

Create Scheduled Userstate Job

This endpoint allows you to create scheduled statechange jobs.

Sample Request

curl -X POST "https://console.jumpcloud.com/api/v2/bulk/userstates" \
  -H 'x-api-key: {API_KEY}' \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d '{
    "user_ids": ["{User_ID_1}", "{User_ID_2}", "{User_ID_3}"],
    "state": "SUSPENDED",
    "start_date": "2000-01-01T00:00:00.000Z"
  }'
post/api/v2/bulk/userstates

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Request body

user_idsstring[] required

Array of system user ids to schedule for a state change

state'ACTIVATED' | 'SUSPENDED' required

The state to move the user(s) to

start_datestring date-time required

Date and time that scheduled action should occur

send_activation_emailsboolean

Set to true to send activation or welcome email(s) to each user_id upon activation. Set to false to suppress emails. Can only be used with scheduled activation(s).

activation_email_overridestring

Send the activation or welcome email to the specified email address upon activation. Can only be used with a single user_id and scheduled activation. This field will be ignored if send_activation_emails is explicitly set to false.

Response

Created

scheduledJobIdstring

The id of the scheduled job that scheduled the state change.

scheduledDatestring

The UTC date and time when the scheduled job will execute.

statestring

The state that the user will be in once the scheduled job executes.

systemUserIdstring

The id of the user that the scheduled job will update.

Changes

No recorded changes to this operation across all 1 revision of this API.