Skip to content
Bottle

Save what the owner confirmed

POST
/rounds/learned/understood
curl --request POST \
  --url https://example.com/rounds/learned/understood \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "items": [ { "kind": "prefer_driver", "scopeType": "business", "scopeId": "example", "effect": "example", "statement": "example", "where": "example" } ] }'

Checks every id and value again, and keeps each as the owner’s word. A hard limit still wins over any of them.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
items
required
Array<object>
>= 1 items <= 40 items
object
kind
required
string
Allowed values: prefer_driver time_window avoid_weekday service_time run_order reserve_load note
scopeType
required
string
Allowed values: business customer address driver vehicle area
scopeId
required
string | null
<= 200 characters
effect
statement
required
string
>= 1 characters <= 500 characters
where
string | null

Responses

Section titled “Responses”

200

Section titled “200”

How many were saved, and how many could not be

Media typeapplication/json
object
saved
required
integer
refused
required
Array<integer>

Example generated

{
  "saved": 1,
  "refused": [
    1
  ]
}

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

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 found

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

The words can’t be kept, with the reason

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