Siren

Update Distributor

Updates an existing distributor. Only provided fields are changed.

Last updated: April 9, 2026

Update Distributor

PUT /siren/v1/distributors/{id}

Updates an existing distributor. Only provided fields are changed. The record must exist (enforced by RecordExistsMiddleware).

Request Body:

FieldTypeRequiredDescription
idintegerYesDistributor ID (must match the URL parameter)
namestringNoUpdated name
descriptionstringNoUpdated description
distributionResolverstringNoUpdated incentive resolver (must be a registered resolver)
distributionPoolResolverstringNoUpdated pool resolver
statusstringNoUpdated status: active or inactive
unitsstringNoUpdated currency identifier (must be a registered currency)
schedulestring[]NoUpdated distribution schedule

Example Request:

{
  "id": 2,
  "name": "Bi-Weekly Commission",
  "schedule": ["first day of next month", "+14 days"]
}

Example Response:

Returns the full updated distributor record with a 200 status.

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