Schedules

Bulk Cancel Schedules

Cancel multiple schedules in one call.

Per-item outcomes:

  • succeeded — schedule was canceled.
  • skipped (error_code=ineligible_status) — schedule status is not SCHEDULED/QUEUED/DEFERRED.
  • failed (error_code=not_found) — schedule not found in workspace.
post/v1/schedules/bulk-cancel

Request

  • Base URL: https://api.pinbridge.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.pinbridge.io/v1/schedules/bulk-cancel
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Headers

x-api-keystring nullable
authorizationstring nullable

Request body

idsstring[] required

List of resource IDs to act on (up to 500 per request).

Response

Successful Response

succeeded_countinteger required
skipped_countinteger required
failed_countinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.