Skip to content
Bottle

Mark awards as celebrated

POST
/setup/awards/seen
curl --request POST \
  --url https://example.com/setup/awards/seen \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "keys": [ "example" ] }'

Each award is celebrated once. The app says which it has shown, and they are not shown again.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
keys
required
Array<string>
<= 50 items
Examplegenerated
{
  "keys": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Where it stands now

Media typeapplication/json
object
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
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"
}

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