API Reference

Rules Lists

Lists

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Bulk Operations

Get bulk operation status

client.rules.lists.bulkOperations.get(stringoperationID, BulkOperationGetParams { account_id } params, RequestOptionsoptions?): BulkOperationGetResponse

GET/accounts/{account_id}/rules/lists/bulk_operations/{operation_id}

ModelsExpand Collapse

BulkOperationGetResponse = ListsBulkOperationPendingOrRunning { id, status } | ListsBulkOperationCompleted { id, completed, status } | ListsBulkOperationFailed { id, completed, error, status }

One of the following:

ListsBulkOperationPendingOrRunning { id, status }

id: string

The unique operation ID of the asynchronous action.

status: "pending" | "running"

The current status of the asynchronous operation.

One of the following:

"pending"

"running"

ListsBulkOperationCompleted { id, completed, status }

id: string

The unique operation ID of the asynchronous action.

completed: string

The RFC 3339 timestamp of when the operation was completed.

status: "completed"

The current status of the asynchronous operation.

ListsBulkOperationFailed { id, completed, error, status }

id: string

The unique operation ID of the asynchronous action.

completed: string

The RFC 3339 timestamp of when the operation was completed.

error: string

A message describing the error when the status is failed.

status: "failed"

The current status of the asynchronous operation.