About Notification Preferences

What are Notification Preferences?

Notification Preferences are settings for users to control how they will be notified about updates from Cirro and Spaces.

Endpoints

GET https://api.cirro.io/v2/users/:id/notification_preference POST https://api.cirro.io/v2/users/:id/notification_preferences

The Notification Preferences object

Attributes

Attribute	Type	Description
`id`	`string`	The unique identifier of the notification preference
`object`	`string`	Always "notification_preference"
`locale`	`string`	Selected language of the notification
`topics`	`array` of `topics`	List of topics related to the notification preference

Example

{
  "id": "1",
  "object": "notification_preference",
  "locale": "de",
  "topics": {
    "object": "list",
    "data": [
      {
        "id": "1",
        "object": "notification_topic_preference",
        "preferences": {
          "email": "immediately"
        }
      }
    ]
  }
}