Skip to content
calternal docs

Preview block reminder delivery

POST
/api/v1/notifications/reminders/preview
curl --request POST \
  --url https://example.com/api/v1/notifications/reminders/preview \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "audience": "example", "instant": "example", "note_id": "example" }'

Show who will receive a block reminder for a Note at the requested time. Set audience to everyone or only_me. The response shows each person’s local time and whether quiet hours delay delivery. Route: /api/v1/notifications/reminders/preview. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

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

everyone or only_me.

string
instant
required

Absolute trigger time as a bounded RFC 3339 instant.

string
note_id
required

Stable Note ID owned by the authenticated User.

string
Examplegenerated
{
  "audience": "example",
  "instant": "example",
  "note_id": "example"
}

Responses

Section titled “Responses”

200

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

Current internal Share recipients and their local delivery state.

Array<object>
object
held_by_quiet_hours
required

True when quiet hours delay this recipient’s delivery.

boolean
id
required

Stable User identity for this preview row.

string
label
required

Display name of the recipient, or “You” for the person setting it.

string
local_time
required

Local date and time for this absolute instant.

string
zone
required

IANA time zone used to render this recipient’s delivery time.

string
Examplegenerated
{
  "recipients": [
    {
      "held_by_quiet_hours": true,
      "id": "example",
      "label": "example",
      "local_time": "example",
      "zone": "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"
  }
}