Sign in

v1

latestOpenAPI 3.0.02026-07-2466275257.1 KB
BulkCampaignOperations

Retrieve bulk operation status

This endpoint retrieves the status and details of a bulk campaign operation using the bulk operation ID. It has been enhanced to support pagination (default: 20 items per page) and status-based filtering, for improved performance and targeted data retrieval.

get/v3/campaigns/bulk/status/{id}

Path parameters

idstring required

The unique identifier of the bulk operation.

Query parameters

pageTokenstring

Pagination token to retrieve the next page of results.

pageSizestring int64

The number of items to retrieve per page.

statusstring

Filter items by status (e.g., BULK_ITEM_SUCCESS, BULK_ITEM_FAILED).

Response

Provides the status and details for the requested bulk campaign operation.

bulkIdstring

Unique identifier for the bulk operation.

resource'BULK_OPERATION_RESOURCE_BILLING' | 'BULK_OPERATION_RESOURCE_CAMPAIGN' | 'BULK_OPERATION_RESOURCE_AUTH'
operationType'BULK_OPERATION_TYPE_CAMPAIGN_UPDATE' | 'BULK_OPERATION_TYPE_CAMPAIGN_STATE_UPDATE' | 'BULK_OPERATION_TYPE_WALLET_UPDATE' | 'BULK_OPERATION_TYPE_TEAM_UPDATE' | 'BULK_OPERATION_TYPE_WALLET_CREATE' | 'BULK_OPERATION_TYPE_TEAM_CREATE' | 'BULK_OPERATION_TYPE_CAMPAIGN_CREATE' | 'BULK_OPERATION_TYPE_INVITE_USER' | 'BULK_OPERATION_TYPE_REMOVE_USER'
status'BULK_OPERATION_SUBMITTED' | 'BULK_OPERATION_IN_PROGRESS' | 'BULK_OPERATION_COMPLETED' | 'BULK_OPERATION_FAILED'
totalCountstring int64

Total number of items in the bulk operation.

successCountstring int64

Number of items processed successfully.

failureCountstring int64

Number of items that failed processing.

createdAtstring date-time

Timestamp when the bulk operation was created.

updatedAtstring date-time

Timestamp when the bulk operation was last updated.

nextPageTokenstring

Token to retrieve the next page of results.