Pause all outreach

POSThttps://api.norreach.app/v1/workspace/outreach/pause

The brake: every running campaign and automation is paused and queued messages are cancelled, and nothing reaches anyone (no email, text, WhatsApp, LinkedIn step or AI call) until it's resumed — in the app or with /resume. Works while already paused (anything that slipped in is stopped too). Owners, admins and managers.

⚠ workspace:adminRole must allow: outreach.pauseSupports dry_runOperation id: pause_outreach

POST/workspace/outreach/pause

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

Pause all outreach

{
  "object": "outreach_pause",
  "paused": true,
  "paused_at": "2026-11-05T10:00:00.000Z",
  "paused_by": "Alex Andersson",
  "changed": true,
  "dry_run": false,
  "campaigns_paused": 3,
  "messages_canceled": 41,
  "note": "All outreach is paused. Nothing goes out until it's resumed."
}

Authorizations

Authorizationstringheaderrequired

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

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 all outreach

object"outreach_pause"required

pausedbooleanrequired

paused_atstring | nullrequired

paused_bystring | nullrequired

changedbooleanrequired

dry_runbooleanrequired

campaigns_pausedintegerrequired

Pause: running campaigns and automations it paused (a dry run: would pause).

messages_canceledintegerrequired

Pause: queued messages it cancelled (a dry run: would cancel).

notestring | nullrequired

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.
409	`idempotency_in_progress`	A request with this Idempotency-Key is still running.
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/workspace/outreach/pause

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

Pause all outreach

{
  "object": "outreach_pause",
  "paused": true,
  "paused_at": "2026-11-05T10:00:00.000Z",
  "paused_by": "Alex Andersson",
  "changed": true,
  "dry_run": false,
  "campaigns_paused": 3,
  "messages_canceled": 41,
  "note": "All outreach is paused. Nothing goes out until it's resumed."
}