Skip to content
Browse all topics
Updated · by the Nerro team

API reference

Launch, pause, resume and cancel

Launch a tested campaign with your consent statement, and pause, resume or cancel it while it runs.

Each action is a POST to /campaigns/{id}/<action> and answers with the campaign, like GET /campaigns/{id}.

POST /campaigns/{id}/launch

{ "consent_text": "Every person is a current tenant who agreed to be contacted by us." }

consent_text is kept with the campaign as your record. Launch is refused, with a message saying why, until:

  • the campaign is a draft with at least one person who can be called,
  • its employee is live and has a phone number from Nerro, and
  • its practice calls have passed. You run those in Nerro, on the campaign's page.

POST /campaigns/{id}/pause

Stops new calls. Calls already going finish. Works on a running, scheduled or queued campaign.

POST /campaigns/{id}/resume

Starts a paused campaign again.

POST /campaigns/{id}/cancel

Ends the campaign for good. Nobody else in it is called.

Still stuck? Email support@nerro.si. A person replies within 24 business hours.