Skip to main content
POST
Cancel pending hooks in bulk. Cancelled hooks will not be delivered. Bulk actions availability may vary by plan.

SDK Methods

All methods return { affected: number } — the count of hooks that were cancelled.

Authorizations

X-API-Key
string
header
required

Body

application/json

Bulk action request. Provide either hookIDs for specific hooks, or startTime/endTime/limit for a filter-based selection.

hookIDs
string[]

Array of hook IDs to act on (max 1000). Mutually exclusive with filter parameters.

Maximum array length: 1000
startTime
string<date-time>

Start of time range filter (RFC 3339). Use with endTime and limit.

endTime
string<date-time>

End of time range filter (RFC 3339). Use with startTime and limit.

limit
integer

Maximum number of hooks to act on (1-1000). Required with time range filters.

Required range: 1 <= x <= 1000
endpointKey
string

Optional. Filter by endpoint key.

sequenceID
string

Optional. Filter by sequence ID.

Response

200 - application/json

Bulk cancel initiated

data
object