Lists
Add subscribers to a List
Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.
POST
/
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.add('list_id', {
recipients: [{ recipientId: 'user_abc' }, { recipientId: 'user_def' }],
});import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
client.lists.subscriptions.add(
list_id="list_id",
recipients=[{
"recipient_id": "user_abc"
}, {
"recipient_id": "user_def"
}],
)package main
import (
"context"
"github.com/trycourier/courier-go/v4"
"github.com/trycourier/courier-go/v4/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
err := client.Lists.Subscriptions.Add(
context.TODO(),
"list_id",
courier.ListSubscriptionAddParams{
Recipients: []courier.PutSubscriptionsRecipientParam{{
RecipientID: "user_abc",
}, {
RecipientID: "user_def",
}},
},
)
if err != nil {
panic(err.Error())
}
}
package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.lists.PutSubscriptionsRecipient;
import com.courier.models.lists.subscriptions.SubscriptionAddParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
SubscriptionAddParams params = SubscriptionAddParams.builder()
.listId("list_id")
.addRecipient(PutSubscriptionsRecipient.builder()
.recipientId("user_abc")
.build())
.addRecipient(PutSubscriptionsRecipient.builder()
.recipientId("user_def")
.build())
.build();
client.lists().subscriptions().add(params);
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
result = courier.lists.subscriptions.add(
"list_id",
recipients: [{recipientId: "user_abc"}, {recipientId: "user_def"}]
)
puts(result)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\PreferenceStatus;
use Courier\ChannelClassification;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$result = $client->lists->subscriptions->add(
'list_id',
recipients: [
[
'recipientID' => 'user_abc',
'preferences' => [
'categories' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
'notifications' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
],
],
[
'recipientID' => 'user_def',
'preferences' => [
'categories' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
'notifications' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
],
],
],
idempotencyKey: 'order-ORD-456-user-123',
xIdempotencyExpiration: '1785312000',
);
var_dump($result);
} catch (APIException $e) {
echo $e->getMessage();
}using System.Collections.Generic;
using TryCourier;
using TryCourier.Models;
using TryCourier.Models.Lists.Subscriptions;
CourierClient client = new();
SubscriptionAddParams parameters = new()
{
ListID = "list_id",
Recipients =
[
new()
{
RecipientID = "user_abc",
Preferences = new()
{
Categories = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
Notifications = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
},
},
new()
{
RecipientID = "user_def",
Preferences = new()
{
Categories = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
Notifications = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
},
},
],
};
await client.Lists.Subscriptions.Add(parameters);courier lists:subscriptions add \
--api-key 'My API Key' \
--list-id list_id \
--recipient '{recipientId: user_abc}' \
--recipient '{recipientId: user_def}'curl --request POST \
--url https://api.courier.com/lists/{list_id}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"recipientId": "user_abc"
},
{
"recipientId": "user_def"
}
]
}
'{
"message": "Example message text",
"type": "invalid_request_error"
}Authorizations
Headers
A unique key that makes this request idempotent. If Courier receives another request with the same Idempotency-Key, it returns the stored response from the first request without performing the operation again (including the original status code and any error). Use it to safely retry POST requests after network failures without risking duplicate sends. The key is scoped to this endpoint.
Response
⌘I
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.add('list_id', {
recipients: [{ recipientId: 'user_abc' }, { recipientId: 'user_def' }],
});import os
from courier import Courier
client = Courier(
api_key=os.environ.get("COURIER_API_KEY"), # This is the default and can be omitted
)
client.lists.subscriptions.add(
list_id="list_id",
recipients=[{
"recipient_id": "user_abc"
}, {
"recipient_id": "user_def"
}],
)package main
import (
"context"
"github.com/trycourier/courier-go/v4"
"github.com/trycourier/courier-go/v4/option"
)
func main() {
client := courier.NewClient(
option.WithAPIKey("My API Key"),
)
err := client.Lists.Subscriptions.Add(
context.TODO(),
"list_id",
courier.ListSubscriptionAddParams{
Recipients: []courier.PutSubscriptionsRecipientParam{{
RecipientID: "user_abc",
}, {
RecipientID: "user_def",
}},
},
)
if err != nil {
panic(err.Error())
}
}
package com.courier.example;
import com.courier.client.CourierClient;
import com.courier.client.okhttp.CourierOkHttpClient;
import com.courier.models.lists.PutSubscriptionsRecipient;
import com.courier.models.lists.subscriptions.SubscriptionAddParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
CourierClient client = CourierOkHttpClient.fromEnv();
SubscriptionAddParams params = SubscriptionAddParams.builder()
.listId("list_id")
.addRecipient(PutSubscriptionsRecipient.builder()
.recipientId("user_abc")
.build())
.addRecipient(PutSubscriptionsRecipient.builder()
.recipientId("user_def")
.build())
.build();
client.lists().subscriptions().add(params);
}
}require "courier"
courier = Courier::Client.new(api_key: "My API Key")
result = courier.lists.subscriptions.add(
"list_id",
recipients: [{recipientId: "user_abc"}, {recipientId: "user_def"}]
)
puts(result)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Courier\Client;
use Courier\PreferenceStatus;
use Courier\ChannelClassification;
use Courier\Core\Exceptions\APIException;
$client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API Key');
try {
$result = $client->lists->subscriptions->add(
'list_id',
recipients: [
[
'recipientID' => 'user_abc',
'preferences' => [
'categories' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
'notifications' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
],
],
[
'recipientID' => 'user_def',
'preferences' => [
'categories' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
'notifications' => [
'foo' => [
'status' => PreferenceStatus::OPTED_IN,
'channelPreferences' => [
['channel' => ChannelClassification::DIRECT_MESSAGE]
],
'rules' => [['until' => 'until', 'start' => 'start']],
],
],
],
],
],
idempotencyKey: 'order-ORD-456-user-123',
xIdempotencyExpiration: '1785312000',
);
var_dump($result);
} catch (APIException $e) {
echo $e->getMessage();
}using System.Collections.Generic;
using TryCourier;
using TryCourier.Models;
using TryCourier.Models.Lists.Subscriptions;
CourierClient client = new();
SubscriptionAddParams parameters = new()
{
ListID = "list_id",
Recipients =
[
new()
{
RecipientID = "user_abc",
Preferences = new()
{
Categories = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
Notifications = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
},
},
new()
{
RecipientID = "user_def",
Preferences = new()
{
Categories = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
Notifications = new Dictionary<string, NotificationPreferenceDetails>(
)
{
{ "foo", new()
{
Status = PreferenceStatus.OptedIn,
ChannelPreferences =
[
new(ChannelClassification.DirectMessage)
],
Rules =
[
new()
{
Until = "until",
Start = "start",
},
],
} },
},
},
},
],
};
await client.Lists.Subscriptions.Add(parameters);courier lists:subscriptions add \
--api-key 'My API Key' \
--list-id list_id \
--recipient '{recipientId: user_abc}' \
--recipient '{recipientId: user_def}'curl --request POST \
--url https://api.courier.com/lists/{list_id}/subscriptions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"recipients": [
{
"recipientId": "user_abc"
},
{
"recipientId": "user_def"
}
]
}
'{
"message": "Example message text",
"type": "invalid_request_error"
}