Skip to main content
POST
/
apps
/
jumpcloud
/
bulk
/
userstates
Create Scheduled Userstate Job
curl --request POST \
  --url https://api.provident.ae/v2/apps/jumpcloud/bulk/userstates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_ids": [
    "<string>"
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "activation_email_override": "<string>",
  "send_activation_emails": true
}
'
[
  {
    "id": "<string>",
    "userId": "<string>",
    "state": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "activationEmailOverride": "<string>",
    "sendActivationEmails": true
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Details for the scheduled state change job.

​
user_ids
string[]
required

An array of system user IDs.

​
state
enum<string>
required

The state to set for the users.

Available options:
ACTIVATED,
SUSPENDED
​
start_date
string<date-time>
required

The timestamp for when the state change will occur.

​
activation_email_override
string

An email address that overrides the system user's primary email address for activation email delivery.

​
send_activation_emails
boolean

Determines if activation emails are sent.

Response

Created

​
id
string
required

The ID of the scheduled state change request.

​
userId
string
required

The ID of the System User this entry is specific to.

​
state
string
required

The state to set for the user.

​
startDate
string<date-time>
required

The timestamp for when the state change will occur.

​
activationEmailOverride
string

An email address that overrides the system user's primary email address for activation email delivery.

​
sendActivationEmails
boolean

Determines if activation emails are sent.