Skip to main content
PUT
/
lists
/
{list_id}
/
subscriptions
JavaScript
import Courier from '@trycourier/courier';

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

await client.lists.subscriptions.subscribe('list_id', { recipients: [{ recipientId: 'recipientId' }] });
{
  "message": "<string>",
  "type": "invalid_request_error"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

list_id
string
required

A unique identifier representing the list you wish to retrieve.

Body

application/json
recipients
PutSubscriptionsRecipient · object[]
required

Response