Docs
Plans

Change a card's words

PATCHhttps://api.norreach.app/v1/cards/{id}

Changes the words of a card that hasn't gone out: subject (email cards) and body (an email's body, a message's text, a post's caption, a call's opening, an ad's primary text), and optionally why. A call card keeps its AI disclosure whatever is sent. A card that is running or already ran can't change (409); a card held on a claim changes in the app, where the claim is decided (409).

plans:writeRole must allow: plan.editOperation id: update_plan_card
PATCH/cards/{id}
curl -X PATCH "https://api.norreach.app/v1/cards/{id}" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "what": {
    "subject": "Winter nurses — ready in 48 hours"
  }
}'
Change a card's words
{
  "id": "5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e",
  "object": "plan_card",
  "plan_id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d",
  "date": "2026-11-12",
  "time_label": "09:30",
  "scheduled_at": null,
  "channel": "email",
  "arc_stage": "awareness",
  "title": "Intro to clinic managers",
  "what": {
    "kind": "email",
    "subject": "Winter nurses — ready in 48 hours",
    "body": "Hi {{first_name}}, …"
  },
  "why": "Clinic managers plan staffing a month ahead.",
  "chain": "Opens feed the follow-up on day 4.",
  "state": "awaiting_approval",
  "conditional": false,
  "cost_class": "free",
  "approved_at": null,
  "hold": "policy",
  "claims": [],
  "outcome": null
}

Authorizations

Authorizationstringheaderrequired

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

Path parameters

idstring (uuid)pathrequired

An id (UUID).

Headers

Idempotency-Keystringheader

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

Body

application/json

whatobjectrequired
Show child attributes
what.subjectstring

Email cards: the subject line.

what.bodystring

The words: an email's body, a message's text, a post's caption, a call's opening, an ad's primary text.

whystring

Response

200application/json— Change a card's words

idstring (uuid)required

An id (UUID).

object"plan_card"required
plan_idstring (uuid)required

An id (UUID).

datestringrequired
time_labelstringrequired
scheduled_atstring | nullrequired
channelstringrequired
arc_stageenumrequired
One of:curiosityawarenessconsiderationproofofferurgencydecision
titlestringrequired
whatobjectrequired

The card's words, by kind: email (subject, body), message (text), post (caption), call (opening), ad (primary …).

whystringrequired
chainstringrequired
stateenumrequired
One of:queuedawaiting_approvalrunningcompletedskippedfailed
conditionalbooleanrequired

Fires on the lead's own behaviour rather than at a set time.

cost_classenumrequired
One of:freelowhighcustomer
approved_atstring | nullrequired
holdenum | nullrequired

Why it waits: policy (your plan's settings), claim (a claim needs checking — decide it in the app), state (the lead's own state).

claimsobject[]required
Show child attributes
claims[].claimstringrequired
claims[].statusenumrequired
One of:flaggedsourced
claims[].sourcestring | nullrequired
outcomeobject | nullrequired

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