Notify API reference

Notify API · Notifications

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

Cancel a notification

Deliveries still pending, scheduled or retrying end `skipped: cancelled`, and recipients not planned yet are never notified. Delivered messages stay (retract inbox items with `…/retract`). Safe to repeat.

Path parameters

workspace_id*string · uuid

Id of the workspace.

notification_id*string · uuid

The notification id.

Response · 200 The cancelled notification.

id*string · uuid

The notification id.

type*string

The notification type key.

status*object

`scheduled` (waiting for `send_at`), `accepted` (planning), `planned`, or `cancelled`.

recipient_count*integer

Recipients notified.

skipped_count*integer

Recipients left out at accept.

channels*array

The channel restriction, if the send had one.

tenant*string

Tenant.

tags*object

Tags, exactly as sent.

actor*object

Who caused it.

exclude_actor*boolean

Whether the actor was left out of the recipients.

cancellation_key*string

The cancellation key.

idempotency_key*string

The send's `Idempotency-Key`.

caller*string

Who sent it: `pak:<id>`, `platform:<user id>`.

send_at*string · date-time

When it is (or was) released.

expires_at*string · date-time

Deliveries not made by then end `failed: expired`.

planned_at*string · date-time

When every recipient was planned.

cancelled_at*string · date-time

When it was cancelled.

retracted_at*string · date-time

When its inbox items were retracted.

created_at*string · date-time

Accepted.

dataobject

The template data, exactly as sent (only on retrieve).

countsarray

Deliveries per channel and state: what became of the send (on list and retrieve).

Example

Request

POST https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/notifications/{notification_id}/cancel
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "type": "string",
  "status": {},
  "recipient_count": 0,
  "skipped_count": 0,
  "channels": [
    "inbox"
  ],
  "tenant": "string",
  "tags": {},
  "actor": {},
  "exclude_actor": false,
  "cancellation_key": "string",
  "idempotency_key": "string",
  "caller": "string",
  "send_at": "2026-01-01T00:00:00.000Z",
  "expires_at": "2026-01-01T00:00:00.000Z",
  "planned_at": "2026-01-01T00:00:00.000Z",
  "cancelled_at": "2026-01-01T00:00:00.000Z",
  "retracted_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "data": {},
  "counts": [
    {
      "channel": {},
      "states": {
        "delivered": 2,
        "skipped": 1
      }
    }
  ]
}