Preferences
This document describes the preferences endpoint, which is used to retrieve account preferences for the authenticated user.
GET /preferences
Get account preferences.
Authorizations
This endpoint requires a BringYour JWT.
Headers:
{
"Host": "api.bringyour.com",
"Authorization": "Bearer YOUR_JWT_TOKEN",
"Accept": "*/*"
}Response
200 Success
Status: 200 OK
Content-Type: application/json
A successful response returns the user's account preferences.
{
"product_updates": true
}| Field | Type | Description |
|---|---|---|
product_updates | boolean | Indicates if the user wishes to receive product updates. |
Example
HTTP Request
GET /preferences HTTP/1.1
Host: api.bringyour.com
Authorization: Bearer YOUR_JWT_TOKEN
Accept: */*Successful HTTP Response
{
"product_updates": true
}