Suppress Profiles

post https://a.klaviyo.com/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 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

Responses

Language

Credentials

Header


xxxxxxxxxx
25
1
curl --request POST \
2
     --url https://a.klaviyo.com/api/profile-suppression-bulk-create-jobs/ \
3
     --header 'Authorization: Klaviyo-API-Key your-private-api-key' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --header 'revision: 2024-07-15.pre' \
7
     --data '
8
{
9
  "data": {
10
    "type": "profile-suppression-bulk-create-job",
11
    "relationships": {
12
      "list": {
13
        "data": {
14
          "type": "list"
15
        }
16
      },
17
      "segment": {
18
        "data": {
19
          "type": "segment"
20
        }
21
      }
22
    }
23
  }
24
}
25
'


xxxxxxxxxx
43
}
1
{
2
  "data": {
3
    "type": "profile-suppression-bulk-create-job",
4
    "id": "string",
5
    "attributes": {
6
      "status": "processing",
7
      "created_at": "2022-11-08T00:00:00+00:00",
8
      "total_count": 10,
9
      "completed_count": 9,
10
      "completed_at": "2022-11-08T00:00:00+00:00",
11
      "skipped_count": 1
12
    },
13
    "relationships": {
14
      "lists": {
15
        "data": [
16
          {
17
            "type": "list",
18
            "id": "Y6nRLr"
19
          }
20
        ],
21
        "links": {
22
          "self": "string",
23
          "related": "string"
24
        }
25
      },

202Success

4XXClient Error

5XXServer Error