Docs
Plans

Ask Nora to change a plan

POSThttps://api.norreach.app/v1/plans/{id}/replan

Tells Nora what to change, in words (and optionally a new ad budget, budget_minor, in the plan's currency). She writes a proposal — nothing changes until it is applied with POST /plans/{id}/replan/apply. Answers 202 with a plan.replan job whose result.proposal is the proposal once written. One change at a time: while one is still being worked out → 409.

plans:writeRole must allow: plan.editOperation id: replan_plan
POST/plans/{id}/replan
curl -X POST "https://api.norreach.app/v1/plans/{id}/replan" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "request": "Fewer posts, more follow-up emails in week two."
}'
Ask Nora to change a plan
{
  "id": "2f9c1a7e-5b3d-4e8f-9a1b-6c7d8e9f0a1b",
  "object": "job",
  "type": "plan.replan",
  "status": "queued",
  "created_at": "2026-11-04T09:12:33.120Z",
  "finished_at": null,
  "result": null,
  "error": null,
  "resource": {
    "object": "plan",
    "id": "6a7b8c9d-0e1f-4a2b-8c3d-4e5f6a7b8c9d"
  }
}

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

requeststringrequired
budget_minorinteger

Response

202application/json— Ask Nora to change a plan

idstring (uuid)required

An id (UUID).

object"job"required
typestringrequired

What the job does (e.g. contacts.import).

statusenumrequired
One of:queuedrunningsucceededfailed
created_atstringrequired

RFC 3339 UTC timestamp with milliseconds.

finished_atstring | nullrequired
resultany | nullrequired

The job's answer once it succeeded.

errorobject | nullrequired

Why it failed.

resourceobject | null

What the job works on — GET it for the full object.

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.