REFERENCE · ALTERNATIVES, STATE CONDITIONS, AND PROGRAMS
PUT /v1/programs/{program_ref}
Upsert a program (4.5.1). Coverage you run for the insureds you enroll, e.g. your occupational accident program. Returns 200 with the program whether it was created or updated. verification attestation: an active enrollment satisfies the matching rule. verification master_policy: the program's master line decides the rule for every enrolled insured.
PARAMETERS
| NAME | TYPE | REQUIRED | DESCRIPTION |
|---|---|---|---|
| program_ref | string | yes | |
| Idempotency-Key | string | no | Optional, and the preferred way to make a retry safe. Send one on every POST and PUT; a replay returns the original response with idempotent_replay true and creates nothing new. POST /documents also accepts an idempotency_key form field as an alias; the header wins when both are sent |
| name | string | yes | |
| coverage_type | string | yes | Same vocabulary as rules (occupational_accident, cargo, auto_liability, workers_comp, general_liability, ...) |
| owner | string | no | Literal "verifying_entity" (default), or one of your consumer_refs |
| verification | enum | no | attestation, master_policy. |
| carrier | string | no | |
| policy_number | string | no | |
| effective_date | string | no | |
| expiration_date | string | no | |
| meta | object | no |
RESPONSE
| FIELD | TYPE | DESCRIPTION |
|---|---|---|
| program_ref | string | |
| name | string | |
| coverage_type | string | |
| owner | string | Literal "verifying_entity", or a consumer_ref |
| verification | enum | attestation, master_policy. |
| master_coverage_line_id | string | |
| carrier | string | |
| policy_number | string | |
| effective_date | string | |
| expiration_date | string | |
| meta | object | |
| created_at | timestamp | |
| updated_at | timestamp | |
| test | boolean |
Errors: 400, 401, 403, 409, 422, 429, 500. Every error body carries error.code, error.message, and error.request_id.