GET ​/api​/v3​/account​/emailpreferences​/:emailprefaccesstoken

Get the email preferences using email_pref_access_token

Response

Example Response

{
  "account": {
    "profile_type": "user",
    "email_preferences": [
      {
        "name": "help_email_notifications",
        "display_name": "Features and App Updates",
        "value": true
      }
    ]
  }
}

Response Parameters

  • account: The account profile of the user identified

    • Required: no
    • profile_type: The type of the account. Options 'user', 'band'
      • Required: yes
      • Type: string
      • Example: user
    • email_preferences: List of email preferences

      • Required: no
      • Type: array
      • Items

        • Required: no
        • name: Name of the email preference property
          • Required: no
          • Type: string
          • Example: helpemailnotifications
        • display_name: Display name of the email preference property
          • Required: no
          • Type: string
          • Example: Features and App Updates
        • value: Value of the email preference property
          • Required: no
          • Type: boolean
          • Example: true

Response Codes

Successful Response Codes

  • 200: Indicates success.

Failure Response Codes

  • 404: Indicates that the email pref access token has expired or is invalid