Skip to content
calternal docs

Snooze a block reminder

POST
/api/v1/notifications/inbox/{id}/reminder/snooze
curl --request POST \
  --url https://example.com/api/v1/notifications/inbox/example/reminder/snooze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "minutes": 1 }'

Delay an active block reminder for the caller. Set minutes to choose how long the server waits before it sends the next reminder. The server marks the current inbox item as read. Route: /api/v1/notifications/inbox/{id}/reminder/snooze. Inputs: id, operation_id. Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Query Parameters

Section titled “Query Parameters”
operation_id
string

Stable client identity for a retryable inbox or reminder action.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
minutes
required

Minutes from now, from 1 minute to 7 days.

integer format: int32
Examplegenerated
{
  "minutes": 1
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
object
expires_ms
required

Server-side Undo deadline in Unix milliseconds.

integer format: int64
kind
required

Mutation kind used to validate receipt access.

string
operation_id
required

Stable client operation identity.

string
result
required

Public result; the inverse remains server-side.

undone_by

Operation that already consumed this inverse, if any.

string | null
Examplegenerated
{
  "expires_ms": 1,
  "kind": "example",
  "operation_id": "example",
  "result": "example",
  "undone_by": "example"
}

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

401

Section titled “401”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

403

Section titled “403”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

404

Section titled “404”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}

409

Section titled “409”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}