Request Format

Readers use reference material to answer concrete formatting questions quickly. This page is a good place to define the request envelope and the naming rules that repeat across endpoints.

Example payload

{
  "data": {
    "id": "doc_123",
    "attributes": {
      "title": "Welcome",
      "status": "draft"
    }
  }
}

Field conventions

Document the rules that stay true across the API:

• identifier format
• timestamp format
• enum casing
• optional versus nullable fields

Validation guidance

If the platform rejects malformed requests consistently, say so here and link to the Errors page for the exact response contract.