Users

User preferences

Changed on

This endpoint lets you retrieve all the information about a user's preferences on notifications. You need to have READ access to this user.

Here are the default values for newly created users

  {
    "reports": {
      "review_management_daily": true,
      "review_management_weekly": true,
      "review_management_monthly": true,
      "daily_review_preferences": {
        "partners": [
          "google_my_business",
          "facebook"
        ],
        "review_type": 2
        }
    },
    "receive_negative_reviews_email_notifications": false
    }
get/user/{user_id}/preferences

Request

Path parameters

user_idstring required

User id

Response

OK

receive_negative_reviews_email_notificationsboolean

Receive a notification when there is a negative review.

Example response

{
  "reports": {
    "daily_review_preferences": {
      "partners": [
        "facebook",
        "google_my_business",
        "tripadvisor"
      ],
      "review_type": 2
    }
  }
}

Changes

    • breaking

      added the new path request parameter user_id

    • info

      api operation id getUserPreferences was added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status