Skip to main content
POST
/
profiles
/
{user_id}
/
lists
JavaScript
import Courier from '@trycourier/courier';

const client = new Courier({
  apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
});

const response = await client.profiles.lists.subscribe('user_id', {
  lists: [{ listId: 'listId' }],
});

console.log(response.status);
{
  "status": "SUCCESS"
}

Documentation Index

Fetch the complete documentation index at: https://www.courier.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

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 representing the user associated with the requested user profile.

Body

application/json
​
lists
SubscribeToListsRequestItem · object[]
required

Response

​
status
enum<string>
required
Available options:
SUCCESS