api.commodity_maps.update

PUT /commodity-map/{id} — ACPortal

Python

api.commodity_maps.update(map_id: str, *, data: CommodityMapUpdateRequest | dict) -> CommodityMap

CLI

ab commodity_maps update <map_id> [--data ...]

PUT /commodity-map/{id}.

Args: map_id: Commodity map identifier. data: Commodity map update payload with custom_name, commodity_id. Accepts a :class:CommodityMapUpdateRequest instance or a dict.

Request model: :class:CommodityMapUpdateRequest

Request body — CommodityMapUpdateRequest

Field	Type	Required	Description
customName	Optional[str]	no	Custom commodity name
commodityId	Optional[str]	no	Linked commodity ID

Response

Returns CommodityMap.

Field	Type	Required	Description
id	Optional[str]	no	Map ID
customName	Optional[str]	no	Custom commodity name
commodityId	Optional[str]	no	Linked commodity ID

---

← Back to api.commodity_maps