Add a suggested delivery area

POST

/rounds/learned/area-suggestions/add

curl --request POST \
  --url https://example.com/rounds/learned/area-suggestions/add \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "driverUserId": "example", "term": "example" }'

Adds it to the driver’s delivery area. 404 if it isn’t on offer any more.

Authorizations

• sessionCookie
  rounds:write
• apiKey
  rounds:write

Request Body^required

Media typeapplication/json

object

driverUserId

required

string

>= 1 characters

term

required

string

>= 1 characters <= 40 characters

Example ^generated

{
  "driverUserId": "example",
  "term": "example"
}

Responses

200

Done

Media typeapplication/json

object

done

required

boolean

Example

{
  "done": true
}

401

Not signed in

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

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

Not found

Media typeapplication/json

object

error

required

string

message

required

string

Example

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

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

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