Siren

Create Distributor

Creates a new distributor with resolver, pool resolver, currency, and optional schedule configuration.

Last updated: April 9, 2026

Create Distributor

POST /siren/v1/distributors

Creates a new distributor record.

Request Body:

FieldTypeRequiredDescription
namestringYesDistributor name
descriptionstringYesHuman-readable description
distributionResolverstringYesIncentive resolver identifier (must be a registered resolver)
distributionPoolResolverstringYesPool resolver identifier
statusstringYesInitial status: active or inactive
unitsstringYesCurrency identifier (must be a registered currency)
schedulestring[]NoArray of DateTime modifier strings for distribution scheduling

Example Request:

{
  "name": "Monthly Commission",
  "description": "Monthly percentage-based commission distribution",
  "distributionResolver": "percentage_based",
  "distributionPoolResolver": "standard_pool",
  "status": "active",
  "units": "USD",
  "schedule": ["first day of next month"]
}

Example Response:

{
  "id": 2,
  "name": "Monthly Commission",
  "description": "Monthly percentage-based commission distribution",
  "distributionResolver": "percentage_based",
  "distributionPoolResolver": "standard_pool",
  "status": "active",
  "units": "USD",
  "dateCreated": "2026-04-08T12:00:00Z",
  "dateModified": "2026-04-08T12:00:00Z"
}

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