Bulk Actions

Get bulk action session status

Returns the status of a bulk action session that is not scoped to packages - for example the session created when inviting users in bulk.

Bulk actions are processed in the background, so they do not report success or failure immediately. Each bulk action returns a session identifier; use this operation to poll it. The response reports whether processing is still Pending, Finishing or Finished, and how many items succeeded or failed.

Set IncludeDetails to true to also return per-item results - the identifier and execution time of each item, plus an error code and message for items that failed. FinishedTime is only populated once the session reaches Finished.

GET

/

bulkactionsession

/

{bulkActionSessionId}

Error

A valid request URL is required to generate request examples

{
  "SessionId": "b459d74c-1f90-4d63-9f4a-6de9cead8c5e",
  "Action": "UserEmailInvitationNotification",
  "Status": "Finished",
  "Total": 2,
  "Succeeded": 2,
  "Failed": 0,
  "FinishedTime": "2025-02-27T09:09:46Z",
  "Details": {
    "Succeeded": [
      {
        "Id": "1fdbad81-75e5-4cc8-b113-39255fa119d7",
        "ExecutedTime": "2025-02-27T09:09:40Z"
      },
      {
        "Id": "9b2e6f3a-1c44-4e2b-8a77-2d6f0a1b3c4d",
        "ExecutedTime": "2025-02-27T09:09:42Z"
      }
    ],
    "Failed": []
  }
}

[
  {
    "ErrorCode": "BulkActionSession.NotFound",
    "ErrorMessage": "No bulk action session found with the provided id."
  }
]

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

bulkActionSessionId

string<guid>

required

The unique identifier of the target bulk action session A bulk action session unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Query Parameters

includeDetails

boolean

The result will contain the action details information.

Response

OK.

The bulk action session information.

SessionId

string<guid>

A globally unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Action

enum<string>

Available options:

DeletePackage,

DownloadPackage,

NotifyActors,

RevokePackage,

SkipPackagePhase,

ExtendPackage,

RequestAuditTrails,

DeleteAuditProofs,

PackageStatusUpdate,

SoftDeletePackage,

UserEmailInvitationNotification

Status

enum<string>

Available options:

Pending,

Finishing,

Finished

Total

integer

Succeeded

integer

Failed

integer

FinishedTime

string<dateTime>

Details

object

The bulk action session information per item.

Show child attributes

Download bulk action resultRetrieves the result of a bulk action that produces a `.zip` archive - bulk download packages or bulk download audit trail PDFs - once that bulk action has finished. The archive contains one subfolder per package. Each subfolder holds the documents (as `.pdf` or `.xml`) or the audit trails (as `.pdf`), and the archive also includes a JSON file with information about each package.

Error

A valid request URL is required to generate request examples

{
  "SessionId": "b459d74c-1f90-4d63-9f4a-6de9cead8c5e",
  "Action": "UserEmailInvitationNotification",
  "Status": "Finished",
  "Total": 2,
  "Succeeded": 2,
  "Failed": 0,
  "FinishedTime": "2025-02-27T09:09:46Z",
  "Details": {
    "Succeeded": [
      {
        "Id": "1fdbad81-75e5-4cc8-b113-39255fa119d7",
        "ExecutedTime": "2025-02-27T09:09:40Z"
      },
      {
        "Id": "9b2e6f3a-1c44-4e2b-8a77-2d6f0a1b3c4d",
        "ExecutedTime": "2025-02-27T09:09:42Z"
      }
    ],
    "Failed": []
  }
}

[
  {
    "ErrorCode": "BulkActionSession.NotFound",
    "ErrorMessage": "No bulk action session found with the provided id."
  }
]