Distributors

Change partner's name or allocation

This endpoint enables a distributor to update a partner's name or allocated capacity.

put/partner/{partnerID}

Request

Path parameters

partnerIDstring uuid required

The unique identifier (UUID) of the partner whose details are to be updated

Request body

allocatedCapacityinteger

The updated capacity allocated to this partner

namestring

The new name of the partner

Response

OK

allocatedCapacityinteger

The capacity allocated to this partner under the contract

allowOverdraftboolean

Indicates if the partner can go over it's allocated capacity

detailsstring

Additional details about the partner

distributorContractIdstring

The ID of the distributor's contract (UUID)

idstring

The unique identifier of the partner (UUID)

namestring

The name of the partner

Changes

No recorded changes to this operation across all 1 revision of this API.