HomeGuidesAPI Reference
ChangelogHelp CenterCommunityContact Us
API Reference

Suppress Profiles

🚧

This endpoint is in beta and subject to change.

A beta revision header (2024-07-15.pre) is required to use our beta APIs. Klaviyo APIs in beta are not intended for use in production. See our versioning and deprecation policy for more information.

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
Headers
string
required
Defaults to 2024-07-15.pre

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

Responses

Language
Credentials