User Preference Logs - Courier

You can see a user’s notification preferences two ways. The dashboard shows their current subscriptions and a history of changes, so you can review or audit what a user has chosen. The User Preferences API returns their current preference state across every subscription topic and channel, so you can read preferences into your own systems.

View preferences in the dashboard

Open the Users section in your workspace.
Search for and select a user.
Review their subscription topics and current opt-in status.
Open the user’s preference log to see when they opted in or out and changed settings.

A user's preference change history in the Courier dashboard — User preference logs in the dashboard

Query Preferences with the API

Read preferences programmatically with the User Preferences API:

GET /users/{user_id}/preferences lists every topic preference for a user.
GET and PUT /users/{user_id}/preferences/{topic_id} read or update a single topic.

For multi-tenant workspaces, add the optional tenant_id query parameter to scope the result to one tenant. For read-and-update examples in curl, Node, and Python, see the preferences API tutorial.

curl -X GET "https://api.courier.com/users/{user_id}/preferences" 
  -H "Authorization: Bearer YOUR_API_KEY"

The response lists each topic the user has a preference for:

{
  "paging": { "more": false },
  "items": [
    {
      "custom_routing": ["inbox", "email", "sms"],
      "has_custom_routing": true,
      "default_status": "OPTED_IN",
      "status": "OPTED_IN",
      "section_name": "Notifications",
      "section_id": "pHdYzLqMu12XNxih5EoDJ",
      "topic_id": "D9BX66Y1EM4N6QQ1E1D9VVFFQB0N",
      "topic_name": "Critical Messages"
    }
  ]
}

Field	Description
`status`	The user’s current setting for the topic: `OPTED_IN` or `OPTED_OUT`.
`default_status`	The topic’s default before the user changes it.
`topic_id` / `topic_name`	The subscription topic’s ID and display name.
`section_id` / `section_name`	The section the topic belongs to.
`custom_routing`	The channels the user chose for this topic, if any.
`has_custom_routing`	Whether the user set per-channel choices.

The API returns current preferences only. For a history of changes, use the dashboard.

⌘I