subscriptions
subscriptions

Fire Subscription

Fire a delivery now, due or not — the dry run before go-live and the first delivery on demand. Serves a one-off window; the schedule is untouched except that next_delivery_at moves past now.

A real-size firing (thousands of records: selection, workbook, upload, emails) outlasts an HTTP request, so by default it runs in the background and the response says started; the row's last_delivery carries the result within minutes. ?wait=true runs it inline (tests, small dry runs). An ended delivery never fires; a paused one does — that is the operator's deliberate dry run.

post/api/v1/subscriptions/{subscription_id}/fire

Request

  • Base URL: https://app.goodleads.club (the document declares no server; this is the origin it was published from)
  • URL: https://app.goodleads.club/api/v1/subscriptions/{subscription_id}/fire
  • Auth: API key in header X-API-Key

Path parameters

subscription_idstring uuid required

Query parameters

waitboolean

Response

Successful Response

subscription_idstring uuid required
outcomestring required

Changes

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