Pause a campaign

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

Holds every contact where they are: nothing more is sent until it is resumed. Pausing a paused campaign changes nothing.

⚠ campaigns:launchRole must allow: campaigns.launchSupports dry_runOperation id: pause_campaign

POST/campaigns/{id}/pause

curl -X POST "https://api.norreach.app/v1/campaigns/{id}/pause" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Pause a campaign

{
  "object": "status_change",
  "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "from": "active",
  "status": "paused",
  "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-Keystringheader

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

Response

200application/json— Pause a 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.

Status	Code	Meaning
400	`bad_request`	The request couldn't be read.
400	`unknown_field`	The request has a field this operation doesn't know.
401	`unauthorized`	A valid API key is required.
403	`insufficient_scope`	This API key doesn't have the scope this operation needs.
403	`feature_not_enabled`	The API isn't switched on for this workspace.
403	`role_forbidden`	The key's creator's role can't do this.
404	`not_found`	That doesn't exist.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
409	`conflict`	That conflicts with the current state.
413	`too_large`	The request body is too large.
422	`validation_failed`	The request has invalid fields.
422	`idempotency_mismatch`	This Idempotency-Key was used with a different request.
429	`rate_limited`	Too many requests. Slow down and try again.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/campaigns/{id}/pause

curl -X POST "https://api.norreach.app/v1/campaigns/{id}/pause" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Pause a campaign

{
  "object": "status_change",
  "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
  "from": "active",
  "status": "paused",
  "changed": true,
  "dry_run": false,
  "warnings": [],
  "note": null,
  "enrolled": null
}