Docs
Using the API

Errors

Errors are application/problem+json (RFC 9457) with a stable code. A row of another workspace is always 404 not_found, never 403.

HTTP
HTTP/1.1 422
Content-Type: application/problem+json

{
  "type": "https://api.norreach.app/problems/validation_failed",
  "title": "The request has invalid fields.",
  "status": 422,
  "code": "validation_failed",
  "instance": "6f0c2a9e-…",
  "errors": [{ "path": "phone", "code": "invalid_e164", "message": "phone must include the country code, e.g. +46701234567." }],
  "docs": "https://docs.norreach.app/errors#validation_failed"
}
StatusCodeMeaning
400bad_requestThe request couldn't be read.
400unknown_fieldThe request has a field this operation doesn't know.
400invalid_cursorThat cursor doesn't belong to this list.
400idempotency_key_requiredThis operation needs an Idempotency-Key header.
401unauthorizedA valid API key is required.
401key_revokedThis API key has been revoked.
401key_expiredThis API key has expired.
401legacy_keyThis is an old-style key. Create a new API key in Settings.
401test_keys_not_availableTest keys aren't available. Use a second workspace for testing.
401key_owner_inactiveThe person who created this key no longer has access. Ask an admin to take it over.
403insufficient_scopeThis API key doesn't have the scope this operation needs.
403role_forbiddenThe key's creator's role can't do this.
403ip_not_allowedThis API key can't be used from this address.
403workspace_suspendedThis workspace is suspended.
403feature_not_enabledThe API isn't switched on for this workspace.
403key_suspendedThis API key is suspended after unusual activity. An owner or admin can resume it in Settings.
403member_lockedThis person's role or access can't be changed this way.
404not_foundThat doesn't exist.
405method_not_allowedThis method isn't allowed here.
409conflictThat conflicts with the current state.
409outreach_pausedOutreach is paused for this workspace.
409already_decidedAlready handled.
409idempotency_in_progressA request with this Idempotency-Key is still running.
409no_senderA channel this needs has no connected sender.
409insufficient_creditsThere aren't enough credits for this.
413too_largeThe request body is too large.
422validation_failedThe request has invalid fields.
422send_blockedThis can't be sent to this person.
422publish_blockedThis page can't be published.
422ad_publish_blockedThis ad launch can't be published yet.
422ad_switch_blockedThis campaign can't be switched back on from NorReach.
422ad_network_unsupportedThis can't be done on this ad network from NorReach yet.
422post_schedule_blockedThis post can't be scheduled yet.
422ads_by_planNora makes ads only inside a plan.
422idempotency_mismatchThis Idempotency-Key was used with a different request.
429rate_limitedToo many requests. Slow down and try again.
429send_cap_reachedThe workspace's sending limit for now is reached.
429number_cap_reachedThe workspace's limit for buying numbers through the API is reached.
500server_errorSomething went wrong on our side.
503unavailableThe API isn't available right now. Try again shortly.