Pause a live ad campaign

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

Switches a live campaign off in the ad network now — the same core as the Pause button on Ads › Performance. Always allowed for owners, admins and managers, also while outreach is paused: stopping spend is never held back. Campaigns on the other ad networks are paused in the network's own ads manager (422 ad_network_unsupported). dry_run=true checks it and changes nothing. Fires ad_campaign.paused.

⚠ ads:spendRole must allow: ads.spendSupports dry_runOperation id: pause_ad_campaign

POST/ad-campaigns/{id}/pause

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

Pause a live ad campaign

{
  "object": "ad_campaign_action",
  "campaign_id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
  "action": "pause",
  "dry_run": false,
  "status": "paused",
  "changed": true,
  "note": "Paused — it stops spending within a few minutes."
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication: send Authorization: Bearer <key>, with an API key or an OAuth access token. The key needs the scope ads:spend. 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 live ad campaign

object"ad_campaign_action"required

campaign_idstring (uuid)required

An id (UUID).

actionenumrequired

One of:pauseresume

dry_runbooleanrequired

statusenumrequired

One of:activepaused

changedbooleanrequired

notestringrequired

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.
422	`ad_network_unsupported`	This can't be done on this ad network from NorReach yet.
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/ad-campaigns/{id}/pause

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

Pause a live ad campaign

{
  "object": "ad_campaign_action",
  "campaign_id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
  "action": "pause",
  "dry_run": false,
  "status": "paused",
  "changed": true,
  "note": "Paused — it stops spending within a few minutes."
}