Overview
This endpoint returns your live email subscription types with their IDs. Use it to look up thetopic_id values you pass to Set Subscription Preferences.
When to Use
Use this endpoint when:- Building an integration that unsubscribes people from a specific subscription type
- Mapping your CRM’s own list names onto Userpilot subscription types
- Confirming an ID before a bulk write
Prerequisites
- At least one email subscription type, created in Settings > Email > Subscriptions
- Userpilot API Key from Settings > Environment
Endpoint
The endpoint URL uses the
analytex environment. For EU data residency, use
analytex-eu instead. See Environment
Settings for your specific endpoint.Headers
These endpoints have no versioned behavior, so
X-API-Version is accepted and ignored. Send it if you already send it everywhere else.
Example cURL Command
Response
Only live subscription types appear here. A subscription type still in draft has an ID and accepts writes, but you need to copy that ID from the dashboard.
- Unsubscribed from all is a scope rather than a subscription type. Set it with
"all": trueinstead of atopic_id. - Titles are never accepted as input anywhere in the API. Renaming a subscription type would quietly break your integration, so IDs are the only reference.
Common Issues
Related
- Set Subscription Preferences - Unsubscribe or re-subscribe addresses
- Manage unsubscribes - The same job from the dashboard
- Webhooks - Receive an event when someone unsubscribes in Userpilot