Notify API reference

Notify API · Notifications

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

Retract a notification from inboxes

Archives the notification's inbox items for every recipient (for example once an invite is accepted) and updates their unread counts; open inboxes drop the items. Does not cancel other channels (use `…/cancel`). Safe to repeat.

Path parameters

workspace_id*string · uuid

Id of the workspace.

notification_id*string · uuid

The notification id.

Response · 200 Retracted.

id*string · uuid

The notification id.

items_retracted*integer

Inbox items archived by this call (0 when already retracted).

Example

Request

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

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "items_retracted": 0
}