Sign in
latestOpenAPI 3.0.12026-08-10434791.3 KB

4eedf1838ef4

Pool

Update a pool rule

Update a rule that assigns an attempt to a pool based on conditions.

patch/api/pool_rules/{poolRuleId}

Path parameters

poolRuleIdinteger required

ID of the rule

Request body

poolIdstring

ID of the pool that this rule assigns attempts to.

priorityinteger

Priority of the rule. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority.

Example request

{
  "poolId": "42",
  "priority": 10
}

Response

Pool rule updated

idstring required

ID of the pool rule.

poolIdstring required

ID of the pool that this rule assigns attempts to.

priorityinteger required

Priority of the rule. Rules are evaluated in priority order, from the lowest value to the highest value. Multiple rules cannot have the same priority.

Example response

{
  "id": "42",
  "poolId": "42",
  "priority": 10
}