Activation Email APIs - Get Bulk Activation Email Resend Job Errors

Get Bulk Activation Email Resend Job Errors

Get errors of an activation email resend job by its job ID.

Requires a full or user administrator auth token with a scope of spark-admin:people_write or read-only administrator auth token with a scope of spark-admin:people_read.

GET/v1/identity/organizations/{orgId}/jobs/sendActivationEmails/{jobId}/errors

URI Parameters

orgId

string

Check job status for this organization.

jobId

string

Retrieve job status for this jobId.

Query Parameters

max

number

Limit the maximum number of errors in the response.

Default: 50

Response Properties

items

array[ItemObject]

itemNumber

number

Index of error.

trackingId

string

Unique identifier to track the HTTP request.

error

ErrorObject

Error details.

key

string

HTTP status code.

message

array[ErrorMessageObject]

List of error messages.

description

string

Error message.

code

string

Internal error code.

locationId

string

Not used.

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.

GET

/v1/identity/organizations//jobs/sendActivationEmails//errors{?max}

Header

Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Query Parameters

max
number
Limit the maximum number of errors in the response.

https://api-usgov.webex.com/v1/identity/organizations/Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi8yMDIwYTkyMC0zMTRjLTQ3NmUtYmNiMS1hNDJhNGI2YzM2MDM/jobs/sendActivationEmails/Y2lzY29zcGFyazovL3VzL0pPQl9JRC9lNzc4NWU3YS1mNmFiLTRjNTEtYWVjOS00YTg5NWQyOTdjMjc/errors?max=100

200 / OK

{
    "items": [
        {
            "itemNumber": 1,
            "error": {
                "key": "304",
                "message": [
                    {
                        "description": "Re-send invite for 875ae291-3430-4ccb-85de-3db73ccb31d8 by bfb4b090-fcea-488a-94f0-0ec1897e20da is suppressed as the user 875ae291-3430-4ccb-85de-3db73ccb31d8 has already received an invitation email in last 24 hours ; Error with user@example.com.",
                        "code": "ATLAS-600199",
                        "locationId": null
                    }
                ]
            },
            "trackingId": "NA_e0047e0e-804b-4cbc-817a-80c99d5a87a2_1_2"
        }
    ]
}