{"openapi":"3.1.0","info":{"title":"POST /api/v1/automation-settings/plan","version":"1.0.0","description":"Preview an automation settings change"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/automation-settings/plan":{"post":{"tags":["automation-settings"],"summary":"Preview an automation settings change","description":"Validates a change and lists what it would do without saving. ``widening`` names the changes that give the automation more room (turning one on, lowering a confidence line, raising or removing a cap, dropping a review step); ``errors`` maps refused keys to why.","operationId":"plan_automation_settings","parameters":[{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationSettingsChangeRequest"},"example":{"settings":{"inbox_auto_post_enabled":true,"inbox_auto_post_max_amount_cents":50000}}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_AutomationSettingsPlan_"}}}},"401":{"description":"Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business","content":{"application/json":{"example":{"error":"unauthorized","message":"Authentication required","code":"AUTH_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - Insufficient permissions","content":{"application/json":{"example":{"error":"forbidden","message":"You don't have permission to access this resource","code":"AUTH_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error - Request body or parameters failed validation","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: amount: Input should be a valid integer","errors":{"amount":"Input should be a valid integer"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"x-fastapi-operation-id":"plan_automation_settings_api_v1_automation_settings_plan_post"}}},"components":{"schemas":{"AutomationSettingChange":{"properties":{"key":{"type":"string","title":"Key"},"old":{"title":"Old"},"new":{"title":"New"},"widening":{"type":"boolean","title":"Widening","description":"True when the change gives the automation more room"},"line":{"type":"string","title":"Line","description":"Human line, e.g. 'Auto-post amount cap: no cap → $500.00'"}},"type":"object","required":["key","widening","line"],"title":"AutomationSettingChange"},"AutomationSettingsChangeRequest":{"properties":{"settings":{"additionalProperties":true,"type":"object","minProperties":1,"title":"Settings"}},"type":"object","required":["settings"],"title":"AutomationSettingsChangeRequest","description":"Setting key → new value. Money is integer cents; null clears.","example":{"settings":{"inbox_auto_post_enabled":true,"inbox_auto_post_max_amount_cents":50000}},"examples":[{"settings":{"inbox_auto_post_enabled":true,"inbox_auto_post_max_amount_cents":50000}}]},"AutomationSettingsPlan":{"properties":{"changes":{"items":{"$ref":"#/components/schemas/AutomationSettingChange"},"type":"array","title":"Changes"},"widening":{"items":{"type":"string"},"type":"array","title":"Widening","description":"Keys of the changes that widen"},"errors":{"additionalProperties":{"type":"string"},"type":"object","title":"Errors","description":"Key → why the value was refused"}},"type":"object","title":"AutomationSettingsPlan","description":"What an update would do; nothing is written."},"SuccessEnvelope_AutomationSettingsPlan_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/AutomationSettingsPlan"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[AutomationSettingsPlan]"},"ErrorResponse":{"title":"ErrorResponse","type":"object","description":"Envelope returned by every non-2xx response. Branch on `code` (stable) rather than `message` (human-readable, may change).","required":["error","message","code"],"properties":{"error":{"type":"string","description":"Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`."},"message":{"type":"string","description":"Human-readable explanation, safe to show to end users."},"code":{"type":"string","description":"Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`)."},"request_id":{"type":"string","description":"Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied."},"errors":{"type":"object","additionalProperties":{"type":"string"},"description":"Field-level validation messages keyed by field name. Present on 400/422 validation failures only."}}}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}