FOfountain
notificationQueue

Cancel a notification queue entry

Cancels a planned or scheduled notification so it is never sent. Repeating the call on an entry an admin already cancelled returns it unchanged. Gated behind the NOTIFICATIONS_V2 feature flag.

post/api/servicetodo/processes/notification-queue/{uuid}/cancel

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/servicetodo/processes/notification-queue/{uuid}/cancel
  • Auth
    HTTP bearer

Path parameters

uuidstring uuid required

notification queue entry unique identifier

Response

Returns the cancelled notification queue entry.

Example response

{
  "data": {
    "workerDisplayName": "Hermione Granger"
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}

Changes

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