Skip to main content

Update distributor by id

PUT /v1/distributor/:id

Updates an existing distributor record based on the provided identifier. This endpoint validates the submitted data, applies any allowed modifications, and persists the updated resource. It can be used to change distributor details such as name, activation status, or address. The response includes the latest state of the distributor after the update.

Request Body

{
"name": "Distributor1",
"active": false
}

Response Example

{
"name": "Distributor1",
"tenant": "tenant-id-1",
"active": false,
"address": {
"line2": "",
"street": "",
"zip": "",
"city": "",
"country": "",
"state": ""
},
"_id": "distributor-id-1",
"created": "2025-10-21T15:00:59.342Z",
"updated": "2025-10-21T15:01:42.135Z",
"assignedProductsCount": 0
}