Update Program
Updates an existing program. Only provided fields are changed.
Last updated: April 9, 2026
Update Program
PUT /siren/v1/programs/{id}
Updates an existing program. Only provided fields are changed. The record must exist (enforced by RecordExistsMiddleware). Returns the full updated record in the response body.
Request Body:
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Updated display name |
description | string | No | Updated description |
incentiveType | string | No | Must be a registered incentive type |
incentiveResolverType | string | No | Must be a registered incentive resolver type |
units | string | No | Must be a registered currency identifier |
status | string | No | Updated status: active, inactive, draft, or deleted |
engagementTypes | object | No | Updated engagement type configuration |
Example Request:
{
"status": "inactive",
"description": "Program paused for Q2."
}
Example Response:
{
"id": 1,
"name": "Standard Affiliate Program",
"description": "Program paused for Q2.",
"incentiveType": "commission",
"incentiveResolverType": "percentage",
"status": "inactive",
"units": "USD",
"dateCreated": "2026-04-08T12:00:00Z",
"dateModified": "2026-04-08T14:30:00Z"
}
Error Responses:
404. No record found with that ID.500. Database error.
Events: Broadcasts ProgramActionEvent (action: Update) after success.