User Notification Settings

List of valid attributes:

Attribute	Description	Specifics
unread_messages_email	Whether to send the daily email if the user has unread messages	Can be updated, boolean
user_id	ID of the user the notification settings belong to	Cannot be set

Show

This endpoint returns JSON structured like this:

{
  "data": {
    "id": "67ac4d91-1883-47f8-a9a1-f379bbd29cce",
    "type": "notification_settings",
    "attributes": {
      ...
    }
  }
}

This endpoint returns the user’s notification settings. Each user can only read their own settings.

HTTP Request

GET /api/v1/users/:user_id/notification_settings

URL Parameters

Parameter	Description
user_id	The ID of the user whose notification settings to return

Update

Example request:

{
  "data": {
    "type": "notification_settings",
    "attributes": {
      "unread_messages_email": true
    }
  }
}

Example response:

{
  "data": {
    "id": "67ac4d91-1883-47f8-a9a1-f379bbd29cce",
    "type": "notification_settings",
    "attributes": {
      ...
    }
  }
}

This endpoint updates the user’s notification settings. Each user can only update their own settings.

HTTP Request

PUT /api/v1/users/:user_id/notification_settings

URL Parameters

Parameter	Description
user_id	The ID of the user whose notification settings to update