API Reference

Email Sending

Suppressions

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Bulk import account Email Sending suppressions

client.EmailSending.Suppressions.Import(ctx, params) (*SuppressionImportResponse, error)

POST/accounts/{account_id}/email/sending/suppressions/bulk

Imports up to 1,000 account-level Email Sending suppressions in one request.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

params SuppressionImportParams

AccountID param.Field[string]

Path param

Items param.Field[[]SuppressionImportParamsItem]

Body param

Email string

ExpiresAt TimeOptional

formatdate-time

Note stringOptional

maxLength1000

ReturnsExpand Collapse

type SuppressionImportResponse struct{…}

Deduplicated int64

Errors int64

Invalid int64

Items []SuppressionImportResponseItem

Index int64

Status SuppressionImportResponseItemsStatus

One of the following:

const SuppressionImportResponseItemsStatusProcessed SuppressionImportResponseItemsStatus = "processed"

const SuppressionImportResponseItemsStatusInvalid SuppressionImportResponseItemsStatus = "invalid"

const SuppressionImportResponseItemsStatusError SuppressionImportResponseItemsStatus = "error"

const SuppressionImportResponseItemsStatusSkipped SuppressionImportResponseItemsStatus = "skipped"

ID stringOptional

formatuuid

Email stringOptional

formatemail

Error stringOptional

Processed int64

Skipped int64

Total int64

Bulk import account Email Sending suppressions

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/email_sending"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.EmailSending.Suppressions.Import(context.TODO(), email_sending.SuppressionImportParams{
    AccountID: cloudflare.F("54442216"),
    Items: cloudflare.F([]email_sending.SuppressionImportParamsItem{email_sending.SuppressionImportParamsItem{
      Email: cloudflare.F("email"),
    }}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Invalid)
}

200 example

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "deduplicated": 1,
    "errors": 0,
    "invalid": 1,
    "items": [
      {
        "index": 0,
        "status": "processed",
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "email": "user@example.com",
        "error": "Invalid email"
      }
    ],
    "processed": 2,
    "skipped": 0,
    "total": 4
  },
  "success": true
}

Returns Examples

200 example

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "deduplicated": 1,
    "errors": 0,
    "invalid": 1,
    "items": [
      {
        "index": 0,
        "status": "processed",
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "email": "user@example.com",
        "error": "Invalid email"
      }
    ],
    "processed": 2,
    "skipped": 0,
    "total": 4
  },
  "success": true
}