Skip to main content
GET
/
users
/
{user_id}
/
preferences
/
{topic_id}
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: 'My API Key',
});

const response = await client.users.preferences.retrieveTopic('topic_id', { user_id: 'user_id' });

console.log(response.topic);
{
  "topic": {
    "custom_routing": [
      "direct_message"
    ],
    "default_status": "OPTED_IN",
    "has_custom_routing": true,
    "status": "OPTED_IN",
    "topic_id": "<string>",
    "topic_name": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

user_id
string
required

A unique identifier associated with the user whose preferences you wish to retrieve.

topic_id
string
required

A unique identifier associated with a subscription topic.

Query Parameters

tenant_id
string | null

Query the preferences of a user for this specific tenant context.

Response

topic
object
required