Update a material pool
Authorizations
OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.
Headers
ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.
"org_01k83mfmhgchya944v86ryvhpq"
Path Parameters
"mpl_01k2xytkbr0pxazkxbj4j5gr0y"
Body
Human-readable name for the pool. Pass null to clear it.
100Physical form of the pool: a solid pile or a liquid tank.
pile, tank Archived pools are excluded from inventory views and are never auto-selected as a transaction target.
A optional custom ID that can be set to an internal ID from your system. This ID must be unique within all objects of the organisation you operate in. You can later use this external ID to reference and query this object. Be aware that you can update this ID later. If you need an immutable ID, use the object ID returned when creating the object. Pass null to remove it.
1 - 100^[A-Za-z0-9\-_]+$"POOL-EXT-0001"
Response
Material pool updated.
Unique identifier of the material pool.
"mpl_01k2xytkbr0pxazkxbj4j5gr0y"
The external ID you assigned to this pool, if any.
"POOL-EXT-0001"
User-given name of the pool, if any.
"Woodchips pile north"
Physical form of the pool: a solid pile or a liquid tank.
pile, tank "pile"
How mixed material is attributed to its sources during carbon accounting: queue consumes contributions oldest-first (FIFO), stack newest-first (LIFO). Fixed at creation.
queue, stack "stack"
Archived pools are excluded from inventory views and are never auto-selected as a transaction target.
false
The site owning this pool.
Current per-material balances.
Time the pool was created.
"2025-10-10T21:03:58Z"