HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Bulk Unsubscribe Profiles

🚧

Profiles not in the specified list will be globally unsubscribed. Always verify profile list membership before calling this endpoint to avoid unintended global unsubscribes.

Unsubscribe one or more profiles from email marketing, SMS marketing, push marketing, or a combination. Learn more about consent in this guide.

Push tokens provided in subscriptions.push.tokens will be removed for the specified profiles.

To remove someone from a list without changing their subscription status, use Remove Profiles from List.

Maximum number of profiles per call: 100

Rate limits:
Burst: 75/s
Steady: 750/m

Scopes:
lists:write
profiles:write
subscriptions:write

Body Params

Unsubscribes one or more profiles from marketing. Supports email, SMS, WhatsApp, and push channels. All profiles will be removed from the provided list. Either email or phone number is required for email/SMS/WhatsApp channels. Push tokens can be removed by providing token strings directly. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.

data
object
required
Headers
string
required
Defaults to 2026-01-15

API endpoint revision (format: YYYY-MM-DD[.suffix])

Responses
202

Success

Language
Credentials
Header
Response
Choose an example:
application/vnd.api+json