{"openapi":"3.1.0","info":{"title":"PUT /api/v1/credit/programs/{program_id}/event-delivery","version":"1.0.0","description":"Start or stop pushing a program's credit events"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/credit/programs/{program_id}/event-delivery":{"put":{"tags":["credit"],"summary":"Start or stop pushing a program's credit events","description":"Set `event_delivery_mode` to `both` to have every credit event also POSTed, signed, to the business's active endpoints subscribed to it (register them with `POST /webhooks/o2c`), or back to `polling`. The event feed is written in both modes and stays the record. Repeatable: the mode it already has changes nothing. Turning the push on with no active endpoint subscribed to a credit event is `400` `CREDIT_820`. Refused with `403` `CREDIT_818` while an operator holds the mode (`event_delivery_locked`), and `403` `CREDIT_819` on a program an operator set to `webhook`.","operationId":"set_credit_program_event_delivery","parameters":[{"name":"program_id","in":"path","required":true,"schema":{"type":"string","description":"The program.","title":"Program Id"},"description":"The program."},{"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/CreditEventDeliveryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CreditEventDeliveryResponse_"}}}},"400":{"description":"Bad Request - Invalid input","content":{"application/json":{"example":{"error":"validation_error","message":"Validation failed: due_date: Input should be a valid date","errors":{"due_date":"Input should be a valid date"},"code":"GEN_002","request_id":"3f0e7c2a-9b4d-4e1a-8c6f-2d5b7a1e9c30"},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"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":"set_credit_program_event_delivery_api_v1_credit_programs__program_id__event_delivery_put"}}},"components":{"schemas":{"CreditEventDeliveryRequest":{"properties":{"event_delivery_mode":{"type":"string","enum":["polling","both"],"title":"Event Delivery Mode","description":"polling writes the event feed only; both also pushes each event to the business's active endpoints subscribed to it. `webhook` is an operator setting."}},"additionalProperties":false,"type":"object","required":["event_delivery_mode"],"title":"CreditEventDeliveryRequest","description":"How a program's credit events reach the partner."},"CreditEventDeliveryResponse":{"properties":{"program_id":{"type":"string","title":"Program Id","description":"The program."},"event_delivery_mode":{"$ref":"#/components/schemas/EventDeliveryMode","description":"polling (feed only), both (feed and push) or webhook (feed and push; set by an operator). The feed is the record in every mode."},"event_delivery_locked":{"type":"boolean","title":"Event Delivery Locked","description":"An operator holds the mode: `PUT` is refused with `403` `CREDIT_818`."},"pushes":{"type":"boolean","title":"Pushes","description":"Whether events are pushed at all (mode `both` or `webhook`)."},"active_credit_endpoints":{"type":"integer","title":"Active Credit Endpoints","description":"Active endpoints on the business subscribed to at least one `credit.*` event."}},"type":"object","required":["program_id","event_delivery_mode","event_delivery_locked","pushes","active_credit_endpoints"],"title":"CreditEventDeliveryResponse","description":"A program's event delivery, and the endpoints a push would reach."},"EventDeliveryMode":{"type":"string","enum":["webhook","polling","both"],"title":"EventDeliveryMode","description":"How a partner learns that something happened.\n\nThe FRD lists this twice as an open joint decision (§13.3 items 2 and\n6). Making it per-program means the decision never blocks the build:\na partner that wants webhooks registers an endpoint, one that wants to\npoll simply does not."},"SuccessEnvelope_CreditEventDeliveryResponse_":{"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/CreditEventDeliveryResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CreditEventDeliveryResponse]"},"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":[]}]}