Skip to content

Profiles API

Suppress profiles

POSThttps://email.growthdept.ai/api/profile-suppression-bulk-create-jobs

Suppresses up to 100 email addresses, or every member of one list or segment, from email marketing (reason USER_SUPPRESSED).

The request body can be up to 5 MB.

Rate limits

Burst: 75/s

Steady: 750/m

Tier L. See rate limits for how requests are counted.

Scopes

profiles:writesubscriptions:write

Operation id

bulk_suppress_profiles The same operation as in Klaviyo's API. OpenAPI document

Query parameters

array of strings

Attributes of profile-suppression-bulk-create-job resources to return.

Sparse fieldsets guide

Pick values to add them to the request:

Body

Send application/vnd.api+json or application/json.

object

  • dataobjectrequired

    data: 3 fields
    • typestringrequired

      profile-suppression-bulk-create-job
    • attributesobjectrequired

      attributes: 1 field
      • profilesobject

        profiles: 1 field
        • dataarray of objectsrequired

          data: 2 fields
          • typestringrequired

            profile
          • attributesobjectrequired

            attributes: 1 field
            • emailstringrequired

    • relationshipsobject

      relationships: 2 fields
      • listobject

        list: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            list
          • idstringrequired

      • segmentobject

        segment: 1 field
        • dataobjectrequired

          data: 2 fields
          • typestringrequired

            segment
          • idstringrequired

Edit the example. The code samples use what you type here.

Headers

stringrequireddefault 2026-10-15

API revision, YYYY-MM-DD. This server implements 2026-10-15.

Revisions guide

Responses

202Success

No body.

4XXClient error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject

See status codes for each code.

5XXServer error

Response body

object

  • errorsarray of objectsrequired

    errors: 8 fields
    • idstringrequired

    • statusintegerrequired

    • codestringrequired

    • titlestringrequired

    • detailstringrequired

    • sourceobject

      source: 2 fields
      • pointerstring

      • parameterstring

    • linksobject

    • metaobject