Unsubscribe a user profile from a list

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.unsubscribeUser('user_id', { list_id: 'list_id' });

{
  "message": "Example message text",
  "type": "invalid_request_error"
}

DELETE

lists

{list_id}

subscriptions

{user_id}

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.unsubscribeUser('user_id', { list_id: 'list_id' });

{
  "message": "Example message text",
  "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.

user_id

string

required

A unique identifier representing the recipient associated with the list

Response

Subscribe a single user profile to a list Get an audience

⌘I