Skip to content
Bottle

Set how far Bottle can go

PUT
/rounds/autonomy/{decision}
curl --request PUT \
  --url https://example.com/rounds/autonomy/plan \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "level": "background" }'

Moves down at any time. Moves up one level once its checks are met. Agreement with what people sent stands in for how good the plans are.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
decision
required
string
Allowed values: plan sendRounds

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
level
required
string
Allowed values: background suggest send exceptions holiday

Responses

Section titled “Responses”

200

Section titled “200”

Levels

Media typeapplication/json
object
levels
required
Array<object>
object
decision
required
string
Allowed values: plan sendRounds
level
required
string
Allowed values: background suggest send exceptions holiday
nextLevel
required
string | null
Allowed values: background suggest send exceptions holiday
notReady
required
Array<string>
Allowed values: tooFewDays agreesTooLittle tooFewApplied recentBreach notAvailableYet notMeasuredYet atTheTop
checks
required
Array<object>
object
check
required
string
Allowed values: comparedDays agreement
now
required
integer
needed
required
integer
> 0
covers
required
string
Allowed values: tooFewDays agreesTooLittle tooFewApplied recentBreach notAvailableYet notMeasuredYet atTheTop

Example 

{
  "levels": [
    {
      "decision": "plan",
      "level": "background",
      "nextLevel": "background",
      "notReady": [
        "tooFewDays"
      ],
      "checks": [
        {
          "check": "comparedDays",
          "covers": "tooFewDays"
        }
      ]
    }
  ]
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

402

Section titled “402”

Moving up needs the subscription paid up

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not the owner in the office app, or on a plan without rounds

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not open to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

That level is not open yet

Media typeapplication/json
object
error
required
string
message
required
string

Example 

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example 

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}