Send a message

POSThttps://api.norreach.app/v1/messages

Asks for a new email, SMS or WhatsApp message to a SAVED contact (never a free-typed address). It is an API send: it waits in Approvals when the workspace (or campaign_id's campaign) approves before sending, or when the key lacks approvals:decide; approve: true (with approvals:decide) approves it in the same request. When it goes out the engine runs the full send gate again (suppression, do-not-contact, lawful basis, quiet hours, sending window). Up front: blocked → 422 send_blocked with reason; the API's hourly cap (500 messages per workspace) → 429 send_cap_reached. WhatsApp outside the 24-hour window needs an approved template. Poll the result with GET /messages/{id}.

⚠ messages:sendRole must allow: inbox.replyIdempotency-Key requiredSupports dry_runReaches peopleOperation id: send_message

POST/messages

curl -X POST "https://api.norreach.app/v1/messages" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "channel": "email",
  "subject": "Nurses for the summer",
  "text": "Hi Maja, …"
}'

Send a message

{
  "object": "send_request",
  "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "kind": "message",
  "channel": "email",
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "status": "awaiting_approval",
  "approval_key": "rule_send:5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "note": "It waits in Approvals until someone says yes."
}

Authorizations

Authorizationstringheaderrequired

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

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

contact_idstring (uuid)required

An id (UUID).

channelenumrequired

One of:emailsmswhatsapp

textstring

The message (required unless template).

subjectstring

Email: the subject line (required for email).

templateobject

Show child attributes

template.namestringrequired

An approved WhatsApp template of this workspace (GET /templates).

template.languagestring

Its language code, e.g. sv or en_US (default: the template's own).

template.paramsstring[]

Values for the template's variables, in order.

campaign_idstring (uuid)

Send under this campaign's settings (approval mode, sending window).

approveboolean

Response

202application/json— Send a message

object"send_request"required

idstring (uuid) | nullrequired

The request's id — poll GET /messages/{id} or GET /calls/{id} with it.

kindenumrequired

One of:messagecall

channelstringrequired

contact_idstring (uuid)required

An id (UUID).

statusenumrequired

awaiting_approval = it waits in Approvals; queued = approved, it goes out within a minute through the send checks.

One of:awaiting_approvalqueueddry_run

approval_keystring | nullrequired

The Approvals key (approve it with POST /approvals/{key}/approve).

notestringrequired

wouldobject

Dry run: what would happen.

Show child attributes

would.statusenumrequired

One of:awaiting_approvalqueued

Errors

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.
400	`idempotency_key_required`	This operation needs an Idempotency-Key header.
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	`outreach_paused`	Outreach is paused for this workspace.
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.
422	`send_blocked`	This can't be sent to this person.
429	`rate_limited`	Too many requests. Slow down and try again.
429	`send_cap_reached`	The workspace's sending limit for now is reached.
500	`server_error`	Something went wrong on our side.
503	`unavailable`	The API isn't available right now. Try again shortly.

POST/messages

curl -X POST "https://api.norreach.app/v1/messages" \
  -H "Authorization: Bearer $NORREACH_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "channel": "email",
  "subject": "Nurses for the summer",
  "text": "Hi Maja, …"
}'

Send a message

{
  "object": "send_request",
  "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "kind": "message",
  "channel": "email",
  "contact_id": "7d1c3b2a-5e4f-4a1b-9c8d-0e1f2a3b4c5d",
  "status": "awaiting_approval",
  "approval_key": "rule_send:5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "note": "It waits in Approvals until someone says yes."
}