Overview
Subscription management is configured per brand by our Customer Success team. Each configuration includes:- Short codes or long codes for receiving opt-out requests
- Callback URL for receiving subscription events
- Custom messages for STOP, START, and HELP responses (optional)
Contact your Customer Success Manager to set up subscription management for your brand. Alternatively, reach out to Prelude support at support@prelude.so.
How it works
1. User sends keyword
Recipients can send one of the following keywords to your configured phone number:| Keyword | Action |
|---|---|
STOP | Unsubscribe from marketing messages |
START | Resubscribe to marketing messages |
HELP | Request information about the service |
2. Prelude processes the request
When a user sends a keyword:- The subscription status is automatically updated in Prelude’s system
- A confirmation message is sent back to the user
- A webhook event is sent to your callback URL (if configured)
3. Automatic enforcement
Once a user unsubscribes:- Future API calls to send marketing messages to that number will return an error
- The user will not receive any marketing messages until they opt back in
- Transactional messages are not affected by subscription status
Webhook events
You’ll receive webhook events for all subscription changes. See the Webhook documentation for details. Example STOP event:Confirmation messages
When a user sends a keyword, they automatically receive a confirmation message:Default messages
If you don’t configure custom messages, Prelude uses standard defaults: STOP response:Custom messages
Your Customer Success Manager can configure custom messages for your brand to match your voice and include additional information like support contact details.API error handling
When you attempt to send a marketing message to an unsubscribed user, the API will return an error:Always handle the
unsubscribed error in your application logic. Attempting to circumvent subscription preferences violates regulations and our terms of service.