Docs
Ads

Switch a live ad campaign back on

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

Switches a paused campaign back on — it starts spending again. Only within the plan's rules: owners, admins and managers; refused while outreach is paused (409 outreach_paused); only a campaign one of Nora's launches made, and only when its daily budget (the campaign's, else its ad sets' together) is within that launch's daily cap (422 ad_switch_blocked with reason: not_from_norreach, over_cap, budget_unknown). A campaign made outside NorReach is switched on in the network's own ads manager. Other ad networks than Meta: 422 ad_network_unsupported. Idempotency-Key required; dry_run=true runs every check and changes nothing. Fires ad_campaign.resumed.

⚠ ads:spendRole must allow: ads.spendIdempotency-Key requiredSupports dry_runReaches peopleOperation id: resume_ad_campaign
POST/ad-campaigns/{id}/resume
curl -X POST "https://api.norreach.app/v1/ad-campaigns/{id}/resume" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Switch a live ad campaign back on
{
  "object": "ad_campaign_action",
  "campaign_id": "4e5f6a7b-8c9d-4e0f-9a1b-2c3d4e5f6a7b",
  "action": "resume",
  "dry_run": false,
  "status": "active",
  "changed": true,
  "note": "Switched on — it spends within its budget again."
}

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-Keystringheaderrequired

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

Response

200application/json— Switch a live ad campaign back on

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.

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.
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.
422ad_switch_blockedThis campaign can't be switched back on from NorReach.
422ad_network_unsupportedThis can't be done on this ad network from NorReach yet.
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.