Subscriptions

Remind a pass holder

curl -X POST https://api.subscriby.net/v1/subscriptions/$SUBSCRIPTION_ID/remind \
  -H "Authorization: Bearer $SUBSCRIBY_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

The members page's nudge for a pass holder who bought a window but has not joined yet: their invite links are re-sent. Answers 200 with reminded: true when the connector accepted the message, and reminded: false when there was nothing to send: the subscription holds no window, the window has ended or been cancelled, the holder has already queued, or they cannot be reached on their connector. false is the dashboard's "Nothing sent" notice, not a fault, so it is never a 422.

This messages a real person: read the subscription back first and do not repeat the nudge within the same window. To nudge everyone still missing from one window at once, use the pass window remind endpoint.

post/v1/subscriptions/{subscription}/remind

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/subscriptions/{subscription}/remind
  • Auth: HTTP bearer

Path parameters

subscriptionstring uuid required

The subscription, resolved by the route binder.

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

200 with subscription_id and reminded.

Example response

{
  "data": {
    "subscription_id": "5b7e2d40-1a86-4c39-97f2-e83d0b16c5a4",
    "reminded": true
  }
}

Changes

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