Notify API reference

Notify API · Notifications

post/v1/workspaces/{workspace_id}/notifications/cancelAuth

Cancel notifications by cancellation key

Cancels every live notification sent with this `cancellation_key`: deliveries still pending, scheduled or retrying end `skipped: cancelled`. Already delivered messages stay delivered (retract inbox items with `…/retract`). Safe to repeat.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Request body

cancellation_key*string

The `cancellation_key` given at send.

Example: "invite.sent:inv_77"

Response · 200 What was cancelled.

cancelled*array

Notifications that were cancelled (empty when none was live).

deliveries_cancelled*integer

Deliveries moved to `skipped: cancelled`.

Example

Request

POST https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/notifications/cancel
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "cancellation_key": "invite.sent:inv_77"
}

Response

{
  "cancelled": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "deliveries_cancelled": 0
}