Delete subscriptions for many objects in a single collection type. If a subscription for an object in the collection doesn't exist, it will be skipped.

Bulk delete subscriptions

Delete subscriptions for many objects in a single collection type. If a subscription for an object in the collection doesn't exist, it will be skipped.

Endpoint

POST/v1/objects/{collection}/bulk/subscriptions/delete

Rate limit

Tier 1

Path parameters

collection

string

The collection this object belongs to.

Request body

subscriptions

object[]

Required

A nested list of subscriptions.

string

Required

Unique identifier for the object.

recipients

RecipientReference[]

Required

The recipients of the subscription. You can subscribe up to 100 recipients to an object at a time.

Returns

BulkOperation

A bulk operation entity.

__typename

string

The typename of the schema.

completed_at

string(date-time)

Timestamp when the bulk operation was completed.

error_count

integer

The number of failed operations.

error_items

object[]

A list of items that failed to be processed.

collection

string

The collection this object belongs to.

string

Required

Unique identifier for the object.

estimated_total_rows

integer

The estimated total number of rows to process.

failed_at

string(date-time)

Timestamp when the bulk operation failed.

string(uuid)

Unique identifier for the bulk operation.

inserted_at

string(date-time)

Timestamp when the resource was created.

name

string

The name of the bulk operation.

processed_rows

integer

The number of rows processed so far.

progress_path

string(uri)

The URI to the bulk operation's progress.

started_at

string(date-time)

Timestamp when the bulk operation was started.

status

enum(string)

The status of the bulk operation.

queuedprocessingcompletedfailed

success_count

integer

The number of successful operations.

updated_at

string(date-time)

The timestamp when the resource was last updated.