HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Bulk Suppress Profiles

Manually suppress profiles by email address or specify a segment/list ID to suppress all current members of a segment/list.

Suppressed profiles cannot receive email marketing, independent of their consent status. To learn more, see our guides on email suppressions and collecting consent.

Email address per request limit: 100

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

Scopes:
profiles:write
subscriptions:write

Body Params

Suppresses one or more profiles from receiving marketing. Currently, supports email only. If a profile is not found with the given email, one will be created and immediately suppressed.

object
required
string
required
object
required
object

The profile(s) to create suppressions for.

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

Suppress all profiles in this list

object
object
string
required
string
required

Suppress all profiles in this segment

Headers
string
required
Defaults to 2025-01-15

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

Responses

Language
Credentials