Skip to content
Bottle

Change what I want to hear about

PUT
/notification-preferences
curl --request PUT \
  --url https://example.com/notification-preferences \
  --header 'Content-Type: application/json' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
  --data '{ "items": [ { "topic": "orders", "email": true, "inApp": true, "push": true, "flash": true, "browserPush": true } ] }'

Subjects not named are left as they were. Email on a locked subject stays on whatever is sent.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
items
required
Array<object>
<= 13 items
object
topic
required
string
Allowed values: orders rounds deliveries money stock vehicles learning planningAlerts team timeOff cash support account
email
required
boolean
inApp
required
boolean
push
boolean
flash
boolean
browserPush
boolean

Responses

Section titled “Responses”

200

Section titled “200”

The preferences, as they now stand

Media typeapplication/json
object
items
required
Array<object>
object
topic
required
string
Allowed values: orders rounds deliveries money stock vehicles learning planningAlerts team timeOff cash support account
email
required
boolean
inApp
required
boolean
push
required
boolean
flash
boolean
browserPush
boolean

Example 

{
  "items": [
    {
      "topic": "orders"
    }
  ]
}

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”

A key, not a person: notices belong to people

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