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:
| Field | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | Distributor ID (must match the URL parameter) |
name | string | No | Updated name |
description | string | No | Updated description |
distributionResolver | string | No | Updated incentive resolver (must be a registered resolver) |
distributionPoolResolver | string | No | Updated pool resolver |
status | string | No | Updated status: active or inactive |
units | string | No | Updated currency identifier (must be a registered currency) |
schedule | string[] | No | Updated 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.