Docs
Plans

Skip a plan card

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

Says no to a card: it stays in the plan, struck out, and never goes out. The same deciding core as the Approvals page (the key also needs approvals:decide). A card that is running or already ran can't be skipped (409).

⚠ plans:approveRole must allow: plan.approveSupports dry_runOperation id: skip_plan_card
POST/cards/{id}/skip
curl -X POST "https://api.norreach.app/v1/cards/{id}/skip" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Skip a plan card
{
  "object": "card_decision",
  "card_id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
  "decision": "skip",
  "status": "skipped",
  "count": 1,
  "note": "Skipped — the card stays in your plan, struck out.",
  "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-Keystringheader

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

Response

200application/json— Skip 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.
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.