Subscribe to one or more lists
Changed onSubscribes a user to one or more lists, creating any list that does not yet exist. Optional preferences apply to each subscription.
Request
- Base URLhttps://api.courier.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
A unique identifier representing the user associated with the requested user profile.
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.
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
Response
Changes
- info
api tag
User Profilesadded - info
api tag
Profilesremoved
- info
- info
api tag
Profilesadded - info
api tag
User Profilesremoved - info
added the new optional
headerrequest parameterIdempotency-Key - info
added the new optional
headerrequest parameterx-idempotency-expiration
- info