What I want to hear about

GET

/notification-preferences

const url = 'https://example.com/notification-preferences';
const options = {
  method: 'GET',
  headers: {cookie: 'bottle.session_token=<bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/notification-preferences \
  --cookie bottle.session_token=<bottle.session_token>

Per subject, whether this person wants email and whether they want the bell, in this business. Every subject is answered, defaults filled in.

Authorizations

sessionCookie
tenant:read
apiKey
tenant:read

Responses

200

The preferences

application/json

object

items

required

Array<object>

object

topic

required

string

Allowed values: rounds deliveries money stock vehicles team timeOff cash support account

email

required

boolean

inApp

required

boolean

push

required

boolean

Example

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

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

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

403

A key, not a person: notices belong to people

application/json

object

error

required

string

message

required

string

Example

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

422

Validation failed

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