RelayAPI
Subscription Lists

Create a channel-scoped subscription list

Creates an audience definition. Membership in the list does not grant channel or purpose consent.

POST
/v1/subscription-lists

Authorization

Bearer
AuthorizationBearer <token>

API key (rlay_live_* or rlay_test_). Invite redemption also accepts a server-derived rlay_session_ bearer for a current user session.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/subscription-lists" \  -H "Content-Type: application/json" \  -d '{    "channel": "instagram",    "name": "string"  }'
{  "channel": "instagram",  "created_at": "2019-08-24T14:15:22Z",  "description": "string",  "id": "string",  "name": "string",  "organization_id": "string",  "updated_at": "2019-08-24T14:15:22Z",  "workspace_id": "string"}

Found something wrong? Help us improve this page.

Report an issueEdit this page on GitHub

Add or re-add a list member POST

Re-adding an unsubscribed contact opens a new membership interval and preserves the previous transition in immutable history. No consent is granted.

Delete a subscription list DELETE

Next Page