Suppress Profiles
POST {{baseUrl}}/api/profile-suppression-bulk-create-jobs/
> 🚧 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](https://developers.klaviyo.com/en/docs/api_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
Request Body
{"data"=>{"type"=>"profile-suppression-bulk-create-job", "attributes"=>{"profiles"=>{"data"=>[{"type"=>"profile", "attributes"=>{"email"=>"<string>"}}, {"type"=>"profile", "attributes"=>{"email"=>"<string>"}}]}}, "relationships"=>{"list"=>{"data"=>{"type"=>"list", "id"=>"<string>"}}, "segment"=>{"data"=>{"type"=>"segment", "id"=>"<string>"}}}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |