Skip to content
PocketbellAPI

Cancel a Critical notification

POST
/v1/messages/{id}/cancel
curl --request POST \
  --url https://api.pocketbell.dev/v1/messages/msg_01jz9k6q8r3tfv0x2m4n5p7s8a/cancel \
  --header 'Authorization: Bearer <token>'

Stops its repeats, for example when the problem has recovered. It no longer waits for acknowledgment.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
Example
msg_01jz9k6q8r3tfv0x2m4n5p7s8a

Responses

Section titled “Responses”

200

Section titled “200”

Its status after canceling.

Media typeapplication/json
object
id
required
string
status
required

failed: no device could be reached, or the account had no device signed in to send it to; it’s still in the inbox. A Critical notification or a question with no device still waits (awaiting_acknowledgment, awaiting_answer): it’s answered from the inbox once a device signs in.

string
Allowed values: scheduled queued sent delivered failed awaiting_acknowledgment acknowledged awaiting_answer answered canceled expired
priority
required
string
Allowed values: silent quiet normal important critical
created_at
required
string format: date-time
acknowledged_at
required
string | null format: date-time
acknowledged_device
required

The name of the device it was acknowledged on.

string | null
canceled_at
required
string | null format: date-time
expires_at
required

Critical or a question: when it stops repeating or waiting.

string | null format: date-time
answer
required

A question’s answer: the label that was tapped.

string | null
answered_at
required
string | null format: date-time
answered_device
required

The name of the device it was answered on.

string | null
deliveries
required

How many of the account’s devices are at each state.

object
queued
required
integer
sent
required
integer
delivered
required
integer
failed
required
integer
Example
{
  "status": "scheduled",
  "priority": "silent",
  "acknowledged_device": "iPhone",
  "answer": "Approve",
  "answered_device": "iPhone"
}

401

Section titled “401”

Missing, malformed or revoked API key.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Which fields were wrong, for invalid_request.

Array<object>
object
field
required
string
message
required
string
Example
{
  "error": {
    "code": "invalid_request"
  }
}

404

Section titled “404”

No such notification from this Source.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Which fields were wrong, for invalid_request.

Array<object>
object
field
required
string
message
required
string
Example
{
  "error": {
    "code": "invalid_request"
  }
}

429

Section titled “429”

Rate_limited: too many requests with this key; retry after the Retry-After header’s seconds.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Which fields were wrong, for invalid_request.

Array<object>
object
field
required
string
message
required
string
Example
{
  "error": {
    "code": "invalid_request"
  }
}