HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference
These docs are for a deprecated API version. Click here to use the latest version.

Suppress Profiles

Manually suppress one or more profiles. Manually suppressed profiles will not receive email marketing.
Not supported for SMS marketing.
Maximum number of profile can be submitted for suppression: 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
array of objects
required

One or more suppressions to be created.

suppressions*
string
required
Defaults to matt-kemp@klaviyo-demo.com

The email of the profile to suppress / unsuppress.

Headers
string
required
Defaults to 2023-01-24

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

Responses
202

Language
Credentials