Skip to content
Bottle

Complete the first-run business identity check

POST
/setup/activate
curl --request POST \
  --url https://example.com/setup/activate \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Completes activation once the business has a legal structure and registered or trading address. A limited company also needs its Companies House number. Activation is permanent; the setup checklist remains a live view of feature readiness.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Activated, or already activated

Media typeapplication/json
object
activationDone
required
boolean
activationCompletedAt
required
string | null format: date-time
steps
required
Array<object>
object
key
required
string
Allowed values: business invoices vat bases gasTypes products cylinderCharges delivery vehicles people patches shiftPatterns closedDays timeOff planning payments accounting reminders customers standingOrders shop
level
required
string
Allowed values: open sell fleet week automate customers
done
required
boolean
skipped
required
boolean
skippable
required
boolean
required
required
boolean
sticky
required
boolean
answerable
required
boolean
count
required
integer | null
settled
required
integer
total
required
integer
> 0
complete
required
boolean
requiredDone
required
boolean
dismissed
required
boolean
closed
required
boolean
next
required
string | null
Allowed values: business invoices vat bases gasTypes products cylinderCharges delivery vehicles people patches shiftPatterns closedDays timeOff planning payments accounting reminders customers standingOrders shop
levels
required
Array<object>
object
key
required
string
Allowed values: open sell fleet week automate customers
number
required
integer
> 0
steps
required
Array<string>
done
required
boolean
doneCount
required
integer
total
required
integer
> 0
required
required
boolean
currentLevel
required
string | null
Allowed values: open sell fleet week automate customers
awards
required
Array<object>
object
key
required
string
kind
required
string
Allowed values: level first
earned
required
boolean
seen
required
boolean

Example 

{
  "steps": [
    {
      "key": "business",
      "level": "open"
    }
  ],
  "next": "business",
  "levels": [
    {
      "key": "open"
    }
  ],
  "currentLevel": "open",
  "awards": [
    {
      "kind": "level"
    }
  ]
}

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 a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string

Example 

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

409

Section titled “409”

Required business identity fields are missing

Media typeapplication/json
object
error
required
string
Allowed values: activation_incomplete
message
required
string
missing
required
Array<string>
Allowed values: name legalStructure companyNumber registeredAddress

Example 

{
  "error": "activation_incomplete",
  "message": "Customer not found",
  "missing": [
    "name"
  ]
}

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