On this page

    1. Home
    2. API
    3. API Reference
    4. Preferences

    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
    }
    FieldTypeDescription
    product_updatesbooleanIndicates 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
    }


    Powered by Sudoc v2.5.0
    Hide table of contents