Siren

Create Program Group

Creates a new program group with an optional set of program associations.

Last updated: April 9, 2026

Create Program Group

POST /siren/v1/program-groups

Creates a new program group. Optionally associates programs at creation time.

Request Body:

FieldTypeRequiredDescription
namestringYesDisplay name for the group
descriptionstringYesDescription of the group’s purpose
sorterstringYesSorting strategy: oldestBindingWins or newestBindingWins
programsinteger[]NoArray of program IDs to associate with the group. IDs must reference existing programs. Programs already assigned to another group are silently skipped.

Example Request:

{
  "name": "Seasonal Promotions",
  "description": "Holiday and seasonal bonus programs that override the default commission.",
  "sorter": "newestBindingWins",
  "programs": [3, 7]
}

Example Response:

{
  "id": 2,
  "name": "Seasonal Promotions",
  "description": "Holiday and seasonal bonus programs that override the default commission.",
  "sorter": "newestBindingWins"
}

Returns 201 on success. The response includes the core fields of the newly created group. Program associations are created but not reflected in the response. Use GET /siren/v1/program-groups/{id}?fields=id,name,programIds to confirm them.