Errors
Every error is a problem document, with Content-Type: application/problem+json:
{ "type": "https://developer.seaforms.io/api/errors/#validation_failed", "title": "Some answers need fixing", "status": 422, "code": "validation_failed", "detail": "2 answers need fixing.", "errors": { "email": { "key": "invalid_email" }, "budget": { "key": "required" } }, "requestId": "req_01JC8H2K4M7P9X3V5B8N1Q6W2T"}codeis what your program should branch on. It’s stable.titleanddetailare for people, and may change.errorsappears on answers that need fixing, keyed by question, each with a message key and its values.issuesappears on a draft or live config that won’t go through: the publish checker’s list.requestIdis the same as theSeaforms-Request-Idheader. Quote it when you ask us about a problem.
| Status | Code | When |
|---|---|---|
| 400 | bad_request | Malformed JSON, a wrong type, or a property the endpoint doesn't know. |
| 401 | unauthenticated | No token, or a bad or ended one. |
| 401 | session_invalid | A form's session has ended or isn't valid. @seaforms/react renews it and tries again by itself. |
| 403 | forbidden | The key doesn't have the scope, or its maker's role doesn't allow it. |
| 403 | origin_not_allowed | A checkout from an address that isn't on the site's list. |
| 403 | verification_required | This needs a confirmed person, and the form's session isn't one. |
| 403 | payment_blocked | This session had too many failed payments. |
| 403 | plan_required | The site's plan doesn't include this. Carries requiredPlan. |
| 403 | workspace_closed | The workspace was deleted. For 7 days an owner can restore it, and the key works again. |
| 404 | not_found | It doesn't exist, was deleted, or is in another workspace. |
| 409 | form_not_open | The form is paused, closed, scheduled or full. Carries status. |
| 409 | price_changed | A checkout's amount differs from what the visitor saw. Carries the new pricing and payment. |
| 409 | revision_unknown | A checkout from a version of the form we never published. |
| 409 | payments_paused | The form's payments are paused after a spike of failures. |
| 409 | conflict | The object's state doesn't allow this right now. detail says why. |
| 412 | precondition_failed | If-Match is out of date: someone else saved first. Carries current. See Editing safely. |
| 413 | payload_too_large | Over a size limit. |
| 415 | unsupported_media_type | A content type this endpoint doesn't take. |
| 422 | validation_failed | Answers need fixing. Carries errors. |
| 422 | invalid_document | A draft that won't publish, or a live config with errors. Carries issues. |
| 422 | coupon_invalid | A discount code that isn't valid now. Carries reason. |
| 422 | idempotency_key_reused | The same Idempotency-Key with a different body. |
| 428 | precondition_required | This needs If-Match, and it was missing. |
| 429 | rate_limited | Too many requests. Retry-After says when to try again. |
| 500 | server_error | Our fault. It's safe to retry. |
| 503 | unavailable | Something we depend on is down. Retry-After says when to try again. |
ChatGPT is a trademark of OpenAI, and Claude and Claude Code are trademarks of Anthropic. Other product names and logos belong to their owners. None of them makes or endorses Seaforms. Trademarks