Initiate Bulk Activation Email Resend Job
Initiate a bulk activation email resend job that sends an activation email to all eligible users in an organization. Only a single instance of the job can be running for an organization.
Requires a full or user administrator auth token with a scope of spark-admin:people_write.
URI Parameters
Initiate job for this organization.
Response Properties
Job name.
Unique identifier of the job.
Unique identifier to track the flow of HTTP requests.
Unique identifier to identify which user has run the job.
Unique identifier to identify the customer who has run the job.
Unique identifier to identify the customer for which the job was run.
Unique identifier to identify the instance of the job.
Contains the execution statuses of all the steps involved in the execution of the job.
Unique identifier of the step
Step execution start time in UTC format.
Step execution end time in UTC format.
Last time the step's execution status was updated in UTC format.
Displays the most recent execution status of the step.
Step or job has completed.
Step or job is starting.
Step or job is running.
Step or job is stopping.
Step or job has failed with an error.
Step or job has been abandone (manually stopped).
Step or job status is unknown.
Final execution status of the step.
Step or job has completed.
Step or job is starting.
Step or job is running.
Step or job is stopping.
Step or job has failed with an error.
Step or job has been abandone (manually stopped).
Step or job status is unknown.
Step name.
Time elapsed since the step execution started.
Indicates the most recent status of the job at the time of invocation.
Step or job has completed.
Step or job is starting.
Step or job is running.
Step or job is stopping.
Step or job has failed with an error.
Step or job has been abandone (manually stopped).
Step or job status is unknown.
Most recent exit code of the job at the time of invocation.
Job is in progress.
Job has completed successfully.
Job has failed.
Job has been stopped.
Job has completed with errors.
Summary of statuses.
Count of users sent an invitation.
Count of users who failed to receive an invitation.
Count of users who were skipped.
Total count of users processed.
Indicates if the org allows admin invite emails to be sent.
Response Codes
The list below describes the common success and error responses you should expect from the API.
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
{
"name": "resendinviteemail",
"id": "Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc",
"trackingId": "NA_5c8428d1-dbe9-42c3-bb5d-8f0cd98cea07",
"sourceUserId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS9iZmI0YjA5MC1mY2VhLTQ4OGEtOTRmMC0wZWMxODk3ZTIwZGE",
"sourceCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8xNjcwNjc3NS00NTQzLTRmZDMtODY3Ny0wYmEwMWYyNTRlZjQ",
"targetCustomerId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM",
"instanceId": 3,
"jobExecutionStatus": [
{
"id": 3,
"startTime": "2024-05-16T20:24:24.924Z",
"lastUpdated": "2024-05-16T20:24:24.924Z",
"statusMessage": "STARTED",
"exitCode": "UNKNOWN",
"createdTime": "2024-05-16T20:24:24.888Z",
"timeElapsed": "PT0S"
}
],
"latestExecutionStatus": "STARTED",
"latestExecutionExitCode": "UNKNOWN",
"counts": {
"userResendInviteSent": 0,
"userResendInviteFailed": 0,
"userResendInviteSkipped": 0,
"totalUsers": 0
},
"allowAdminInviteEmails": true
}