Pass Windows

Remind a window's holders

Nudges everyone who bought the window but has not yet joined, re-attaching their invite links. It is the panel's Send Reminder button; the automatic reminders a day and an hour before a window opens still run regardless.

curl -X POST https://api.subscriby.net/v1/projects/$PROJECT_ID/pass-windows/$WINDOW_ID/remind \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

reminded is how many holders the connector accepted a message for, not how many were attempted: a holder who has blocked the bot is skipped without costing the rest their nudge. A window that has ended or been cancelled reminds nobody and answers 0 rather than refusing. No event fires: the reminder is a message on the connector, not a state change.

This messages real people. Do not repeat it within the same window, and to nudge one holder rather than a whole window use the subscription remind endpoint.

post/v1/projects/{project}/pass-windows/{window}/remind

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/pass-windows/{window}/remind
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

windowstring uuid required

The window, resolved within the project.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Response

window_id and how many holders were reminded.

Example response

{
  "data": {
    "window_id": "3d5a8c72-b016-4e94-8fa7-61c209d4e738",
    "reminded": 12
  }
}

Changes

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