Skip to content
Bottle

Set who stands in while the owner is away

PUT
/rounds/autonomy-cover
curl --request PUT \
  --url https://example.com/rounds/autonomy-cover \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "deputyUserId": "example", "awayFrom": "example", "awayTo": "example", "dailySummary": true }'

The deputy has to be an owner or admin here. Moves no level and sends nothing.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
deputyUserId
required
string | null
>= 1 characters <= 200 characters
awayFrom
required
string | null
/^\d{4}-\d{2}-\d{2}$/
awayTo
required
string | null
/^\d{4}-\d{2}-\d{2}$/
dailySummary
required
boolean

Example generated

{
  "deputyUserId": "example",
  "awayFrom": "example",
  "awayTo": "example",
  "dailySummary": true
}

Responses

Section titled “Responses”

200

Section titled “200”

Who stands in, and when

Media typeapplication/json
object
deputyUserId
required
string | null
awayFrom
required
string | null
awayTo
required
string | null
dailySummary
required
boolean
candidates
required
Array<object>
object
userId
required
string
name
required
string

Example generated

{
  "deputyUserId": "example",
  "awayFrom": "example",
  "awayTo": "example",
  "dailySummary": true,
  "candidates": [
    {
      "userId": "example",
      "name": "example"
    }
  ]
}

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"
    }
  ]
}