Siren

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:

FieldTypeRequiredDescription
namestringNoUpdated display name
descriptionstringNoUpdated description
incentiveTypestringNoMust be a registered incentive type
incentiveResolverTypestringNoMust be a registered incentive resolver type
unitsstringNoMust be a registered currency identifier
statusstringNoUpdated status: active, inactive, draft, or deleted
engagementTypesobjectNoUpdated 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.