{"openapi":"3.1.0","info":{"title":"POST /api/v1/advisory-firms/{firm_id}/procedures/{procedure_id}/install-everywhere","version":"1.0.0","description":"Install one client's procedure for every client"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/advisory-firms/{firm_id}/procedures/{procedure_id}/install-everywhere":{"post":{"tags":["advisory-firm-procedures"],"summary":"Install one client's procedure for every client","description":"Copy the procedure into every client business of the firm that does not hold it yet (`source_procedure_id` set, the source's `install_count` grows). Idempotent: clients that already hold a copy are reported as `already_installed`, the owner as `source`.","operationId":"install_firm_procedure_everywhere","parameters":[{"name":"firm_id","in":"path","required":true,"schema":{"type":"string","title":"Firm Id"}},{"name":"procedure_id","in":"path","required":true,"schema":{"type":"string","title":"Procedure Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_ProcedureInstallEverywhereResponse_"}}}},"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"}}}},"404":{"description":"Not Found - Resource does not exist","content":{"application/json":{"example":{"error":"not_found","message":"Resource not found","code":"NOT_FOUND_001","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"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"}}}}},"x-fastapi-operation-id":"install_firm_procedure_everywhere_api_v1_advisory_firms__firm_id__procedures__procedure_id__install_everywhere_post"}}},"components":{"schemas":{"ProcedureInstallEverywhereResponse":{"properties":{"source_procedure_id":{"type":"string","title":"Source Procedure Id"},"installed":{"type":"integer","title":"Installed","default":0},"skipped":{"type":"integer","title":"Skipped","default":0},"results":{"items":{"$ref":"#/components/schemas/ProcedureInstallEverywhereResult"},"type":"array","title":"Results"}},"type":"object","required":["source_procedure_id"],"title":"ProcedureInstallEverywhereResponse"},"ProcedureInstallEverywhereResult":{"properties":{"business_id":{"type":"string","title":"Business Id"},"business_name":{"type":"string","title":"Business Name","default":""},"status":{"type":"string","enum":["installed","already_installed","source"],"title":"Status"},"procedure_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Procedure Id"}},"type":"object","required":["business_id","status"],"title":"ProcedureInstallEverywhereResult"},"SuccessEnvelope_ProcedureInstallEverywhereResponse_":{"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/ProcedureInstallEverywhereResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[ProcedureInstallEverywhereResponse]"},"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":[]}]}