HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Bulk Unsubscribe Profiles

Unsubscribe one or more profiles to email marketing, SMS marketing, or both. Learn more about consent in this guide.

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

Maximum number of profile can be submitted for unsubscription: 100

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

Scopes:
lists:write
profiles:write
subscriptions:write

Body Params

Unsubscribes one or more profiles from marketing. Currently, supports email and SMS only. All profiles will be removed from the provided list.
Either email or phone number is required. If a profile cannot be found matching the given identifier(s), a new profile will be created and then unsubscribed.

object
required
string
required
object
required
object
required

The profile(s) to unsubscribe

array of objects
required
data*
string
required
object
required
object
object
object
string
required
string
required

The list to remove the profiles from

Headers
string
required
Defaults to 2025-01-15

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

Responses
202

Success

Language
Credentials