Docs
Plans

Approve a plan card

POSThttps://api.norreach.app/v1/cards/{id}/approve

Says yes to a card waiting for a person, as the key's creator — it goes out when its time comes. The same deciding core as the Approvals page (so the key also needs approvals:decide): the outreach pause, the creator's role, the card re-read in this workspace. Optional edits change its words as it is approved. A card held on a claim → 409 conflict (decide the claim in the app); approving an approved card changes nothing (count: 0). dry_run=true checks it and changes nothing.

⚠ plans:approveRole must allow: plan.approveIdempotency-Key requiredSupports dry_runReaches peopleOperation id: approve_plan_card
POST/cards/{id}/approve
curl -X POST "https://api.norreach.app/v1/cards/{id}/approve" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Approve a plan card
{
  "object": "card_decision",
  "card_id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
  "decision": "approve",
  "status": "queued",
  "count": 1,
  "note": "Approved — it goes out when its time comes.",
  "dry_run": false
}

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

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

Body

application/json

editsobject
Show child attributes
edits.subjectstring
edits.bodystring

Response

200application/json— Approve a plan card

object"card_decision"required
card_idstring (uuid)required

An id (UUID).

decisionenumrequired
One of:approveskip
statusstring | nullrequired

The card's state now (queued once approved, skipped) — dry_run on a dry run.

countintegerrequired

0 when nothing changed (it already was).

notestring | nullrequired
dry_runbooleanrequired

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.
409already_decidedAlready handled.
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.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.