Siren

Create Program

Creates a new program with validated incentive type, resolver, currency, and engagement types.

Last updated: October 26, 2026

POST /siren/v1/programs

Creates a new program. Validates the provided incentive type, incentive resolver type, currency unit, and engagement types against their respective registries before persisting.

Request Body:

FieldTypeRequiredDescription
namestringYesDisplay name
descriptionstringYesHuman-readable description
incentiveTypestringYesMust be a registered incentive type
incentiveResolverTypestringYesMust be a registered incentive resolver type
unitsstringYesA registered currency code, built-in or custom, matched exactly including case
statusstringYesInitial status: active or inactive
engagementTypesobjectYesMap of engagement type keys to their configuration values

Payout amounts in incentiveTypeArgs (payoutPerTransaction, payoutPerProduct, and payoutPerLead) are stored whole numbers in the program’s units. Maximum amounts gives each currency’s limit.

Example Request:

{
  "name": "Standard Affiliate Program",
  "description": "Earn commission on every referred sale.",
  "incentiveType": "commission",
  "incentiveResolverType": "percentage",
  "units": "USD",
  "status": "active",
  "engagementTypes": {
    "link_click": { "value": "100" }
  }
}

Example Response:

{
  "id": 1,
  "name": "Standard Affiliate Program",
  "description": "Earn commission on every referred sale.",
  "incentiveType": "commission",
  "incentiveResolverType": "percentage",
  "status": "active",
  "units": "USD",
  "dateCreated": "2026-04-08T12:00:00Z",
  "dateModified": "2026-04-08T12:00:00Z"
}

Events: Broadcasts ProgramActionEvent (action: Create) after success.

Your privacy choices

Account, checkout and chat you request work without optional tracking. Choose whether to allow these other uses on this website.

You can change or withdraw your choices at any time using “Privacy choices.” We remember your choice for 180 days. Read our privacy policy.