Pause a plan

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

Pauses a running plan: its outreach sequence holds every contact where they stand. Posts already on the social calendar stay there (the answer says so). Pausing a paused plan changes nothing.

⚠ plans:approveRole must allow: plan.approveSupports dry_runOperation id: pause_plan

POST/plans/{id}/pause

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

Pause a plan

{
  "object": "plan_action",
  "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "action": "pause",
  "from": "active",
  "status": "paused",
  "changed": true,
  "dry_run": false,
  "recheck": false,
  "compiled": null,
  "applied": null,
  "warnings": [
    "The outreach sequence is paused — contacts stay exactly where they are in it."
  ],
  "notes": []
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope plans:approve. 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 plan

object"plan_action"required

plan_idstring (uuid)required

An id (UUID).

actionenumrequired

One of:activatepauseapply_replan

fromenumrequired

One of:generatingreviewactivepausedcompletedfailed

statusenumrequired

One of:generatingreviewactivepausedcompletedfailed

changedbooleanrequired

dry_runbooleanrequired

recheckbooleanrequired

activate: a live plan was looked at again (newly connected channels picked up).

compiledinteger | nullrequired

activate: how many cards this pass wired up.

appliedinteger | nullrequired

apply_replan: how many changes landed.

warningsstring[]required

notesstring[]required

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/plans/{id}/pause

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

Pause a plan

{
  "object": "plan_action",
  "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "action": "pause",
  "from": "active",
  "status": "paused",
  "changed": true,
  "dry_run": false,
  "recheck": false,
  "compiled": null,
  "applied": null,
  "warnings": [
    "The outreach sequence is paused — contacts stay exactly where they are in it."
  ],
  "notes": []
}