Docs
Approvals

Approve an item

POSThttps://api.norreach.app/v1/approvals/{key}/approve

Says yes as the key's creator — it goes out (or goes live) through the same checks as the Approvals page: the outreach pause, the creator's role, the item re-read in this workspace. Optional edits change the words (or a meeting's time, length, email or host) as it is approved. An ad launch also needs ads:spend, a landing page pages:publish, a plan card plans:approve. Already decided → 409 already_decided; a claim that needs checking → 409 conflict (decide it in the app). dry_run=true checks it still waits and changes nothing.

⚠ approvals:decideRole must allow: approvals.decideIdempotency-Key requiredSupports dry_runReaches peopleOperation id: approve_approval
POST/approvals/{key}/approve
curl -X POST "https://api.norreach.app/v1/approvals/{key}/approve" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "edits": {
    "body": "Hi Anna, a shorter version …"
  }
}'
Approve an item
{
  "object": "approval_decision",
  "key": "plan_card:5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
  "decision": "approve",
  "status": "approved",
  "count": 1,
  "note": "Approved — it goes out on schedule."
}

Authorizations

Authorizationstringheaderrequired

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

Path parameters

keystringpathrequired

An approval key, e.g. plan_card:<uuid>, meeting:<uuid>, rule_send:<uuid> (URL-encode the colon in paths).

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.

Body

application/json

editsobject

Edits approved together with the item.

Show child attributes
edits.subjectstring
edits.bodystring

The edited words (email body, message text, a card's words).

edits.meetingobject
Show child attributes
edits.meeting.starts_atstring (date-time)
edits.meeting.minutesinteger
edits.meeting.emailstring (email)
edits.meeting.host_idstring (uuid)

Another member to host it (staff only).

edits.meeting.forceboolean

Approve even though the host's calendar shows a clash.

Response

200application/json— Approve an item

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.
409already_decidedAlready handled.
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.
429rate_limitedToo many requests. Slow down and try again.
429number_cap_reachedThe workspace's limit for buying numbers through the API is reached.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.