Skip to content
Bottle

Ask a business to let Bottle support in

POST
/console/businesses/{id}/support-request
curl --request POST \
  --url https://example.com/console/businesses/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/support-request \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "level": "view", "reason": "example", "hours": 24 }'

The business’s owners and admins are told, with the reason, and one of them approves or declines. Approving lets staff open the business as one of its people, to look or to look and change, for the hours asked. Nothing opens until they say yes.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
level
required
string
Allowed values: view act
reason
required
string
>= 10 characters <= 500 characters
hours
required
Any of:
number
Allowed values: 24

Responses

Section titled “Responses”

201

Section titled “201”

Asked

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
tenantId
required

UUID v7

string format: uuid
staffUserId
required
string
staffName
required
string | null
level
required
string
Allowed values: view act
reason
required
string
hours
required
Any of:
number
Allowed values: 24
status
required
string
Allowed values: pending approved declined expired
decidedByName
required
string | null
decidedAt
required
string | null format: date-time
createdAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "tenantId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "level": "view",
  "hours": 24,
  "status": "pending"
}

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 Bottle staff, no two-step sign-in, or a console role too low for this

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

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