TRtreasure
Pool

Update a pool

Update a pool with the specified name and concurrency limit. You cannot update the default pool. The default pool’s concurrency limit is adjusted to accommodate the new concurrency limit. A pool’s concurrency limit cannot be reduced if it has more running attempts than its new reduced concurrency limit.

patch/api/pools/{poolId}

Request

Path parameters

poolIdinteger required

ID of the pool.

Request body

concurrencyLimitinteger

Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.

namestring

Name of the pool. This name must be unique within the account.

Example request

{
  "concurrencyLimit": 10,
  "name": "activation"
}

Response

Pool updated

concurrencyLimitinteger required

Maximum number of concurrent attempts that can run in this pool. Total concurrency limit of all pools cannot exceed the account's concurrency limit.

defaultboolean required

Whether the pool is the default pool.

idstring required

ID of the pool.

namestring required

Name of the pool. This name must be unique within the account.

Example response

{
  "concurrencyLimit": 10,
  "default": true,
  "id": "42",
  "name": "activation"
}

Changes

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