Docs
Campaigns

Resume a paused campaign

POSThttps://api.norreach.app/v1/campaigns/{id}/resume

Puts a paused campaign back live; contacts carry on from where they were. Runs the same launch check as the app: every channel the sequence sends on needs a connected sender (409 no_sender with what to connect), an AI-call step needs an AI caller. Contacts already enrolled start (honouring a scheduled start). dry_run=true runs the checks and changes nothing.

⚠ campaigns:launchRole must allow: campaigns.launchIdempotency-Key requiredSupports dry_runReaches peopleOperation id: resume_campaign
POST/campaigns/{id}/resume
curl -X POST "https://api.norreach.app/v1/campaigns/{id}/resume" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Resume a paused campaign
{
  "object": "status_change",
  "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "from": "paused",
  "status": "active",
  "changed": true,
  "dry_run": false,
  "warnings": [],
  "note": null,
  "enrolled": null
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope campaigns:launch. API keys and scopes

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Query parameters

dry_runbooleanquery

Run every check and return what would happen, changing nothing.

Headers

Idempotency-Keystringheaderrequired

Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.

Response

200application/json— Resume a paused campaign

object"status_change"required
idstring (uuid)required

An id (UUID).

fromstringrequired
statusstringrequired

The status now (or, in a dry run, the one it would get).

changedbooleanrequired
dry_runbooleanrequired
warningsstring[]required

What the launch check found but didn't block on.

notestring | nullrequired
enrolledinteger | nullrequired

Automations: contacts the activation enrolled (a stop's dry run: contacts it would end). Null otherwise.

Errors

Errors are application/problem+json with a stable code.

StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
400idempotency_key_requiredThis operation needs an Idempotency-Key header.
401unauthorizedA valid API key is required.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403feature_not_enabledThe API isn't switched on for this workspace.
403role_forbiddenThe key's creator's role can't do this.
404not_foundThat doesn't exist.
409idempotency_in_progressA request with this Idempotency-Key is still running.
409conflictThat conflicts with the current state.
409no_senderA channel this needs has no connected sender.
409outreach_pausedOutreach is paused for this workspace.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.