EmailPreferencesResponse

email_categories object[]

Every email category on your account, with your current opt-in status.

Array [

slugstring

Unique identifier of the category. Pass this value to the update endpoint.

display_namestring

Name of the category, as shown in the console.

descriptionstring

What the notifications in this category tell you.

requiredboolean

Whether the category is required. You cannot opt out of a required category.

positioninteger

Sort order used to display the category in the console.

iconstringnullable

Icon used by the console. Returns null for child notifications.

opted_inboolean

Whether you currently receive the notifications in this category.

childs object[]

Individual notifications grouped under this category. Empty when the category has no children.

Array [

email_category_idinteger

Identifier for the email category. Returned for child notifications only.

slugstring

Unique identifier of the category. Pass this value to the update endpoint.

display_namestring

Name of the category, as shown in the console.

descriptionstring

What the notifications in this category tell you.

requiredboolean

Whether the category is required. You cannot opt out of a required category.

positioninteger

Sort order used to display the category in the console.

iconstringnullable

Icon used by the console. Returns null for child notifications.

opted_inboolean

Whether you currently receive the notifications in this category.

]

]

jsonEmailPreferencesResponse

{
  "email_categories": [
    {
      "slug": "string",
      "display_name": "string",
      "description": "string",
      "required": true,
      "position": 0,
      "icon": "string",
      "opted_in": true,
      "childs": [
        {
          "email_category_id": 0,
          "slug": "string",
          "display_name": "string",
          "description": "string",
          "required": true,
          "position": 0,
          "icon": "string",
          "opted_in": true
        }
      ]
    }
  ]
}