Change a card's words
https://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).
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"
}
}'{
"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
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
An id (UUID).
Headers
Any unique string (≤ 255). The same key with the same request returns the first answer for 24 hours.
Body
application/json
Show child attributesHide child attributes
Email cards: the subject line.
The words: an email's body, a message's text, a post's caption, a call's opening, an ad's primary text.
Response
200application/json— Change a card's words
An id (UUID).
An id (UUID).
curiosityawarenessconsiderationproofofferurgencydecisionThe card's words, by kind: email (subject, body), message (text), post (caption), call (opening), ad (primary …).
queuedawaiting_approvalrunningcompletedskippedfailedFires on the lead's own behaviour rather than at a set time.
freelowhighcustomerWhy it waits: policy (your plan's settings), claim (a claim needs checking — decide it in the app), state (the lead's own state).
Show child attributesHide child attributes
flaggedsourcedErrors
Errors are application/problem+json with a stable code.
| Status | Code | Meaning |
|---|---|---|
| 400 | bad_request | The request couldn't be read. |
| 400 | unknown_field | The request has a field this operation doesn't know. |
| 401 | unauthorized | A valid API key is required. |
| 403 | insufficient_scope | This API key doesn't have the scope this operation needs. |
| 403 | feature_not_enabled | The API isn't switched on for this workspace. |
| 403 | role_forbidden | The key's creator's role can't do this. |
| 404 | not_found | That doesn't exist. |
| 409 | idempotency_in_progress | A request with this Idempotency-Key is still running. |
| 409 | conflict | That conflicts with the current state. |
| 413 | too_large | The request body is too large. |
| 422 | validation_failed | The request has invalid fields. |
| 422 | idempotency_mismatch | This Idempotency-Key was used with a different request. |
| 429 | rate_limited | Too many requests. Slow down and try again. |
| 500 | server_error | Something went wrong on our side. |
| 503 | unavailable | The API isn't available right now. Try again shortly. |