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

Path parameters

list_idstring required

A unique identifier representing the list you wish to retrieve.

Headers

Idempotency-Keystring

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.

x-idempotency-expirationstring

How long the idempotency key remains valid, as a Unix epoch timestamp in seconds or an ISO 8601 date string. Only applies when Idempotency-Key is provided. If omitted, the key is retained for 25 hours; the maximum is 1 year.

Request body

Changes

Changed in 4 of the 55 revisions of this API.14

    • added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

    • added the new optional header request parameter x-idempotency-expiration

      new-optional-request-parameter

    • added the success response with the status 202

      response-success-status-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • removed the success response with the status 202

      response-success-status-removed

    • added the success response with the status 202

      response-success-status-added