Create account Email Sending suppression

client.EmailSending.Suppressions.New(ctx, params) (*SuppressionNewResponse, error)

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

Creates a suppression for every sending domain of the account (default) or for one sending domain (scope.type = sending_domain). Creating an existing active suppression returns its identifier. If a mutable legacy zone-linked account row already exists, it is promoted without changing its identifier.

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 SuppressionNewParams

AccountID param.Field[string]

Path param: Cloudflare account ID.

Email param.Field[string]

Body param: The email address to suppress.

formatemail

ExpiresAt param.Field[Time]Optional

Body param: Expiration timestamp for the suppression. Omit or set to null for a permanent suppression that never expires.

formatdate-time

Note param.Field[string]Optional

Body param: Advisory note for this suppression. Not enforced or validated beyond length.

maxLength1000

Scope param.Field[SuppressionNewParamsScope]Optional

Body param: Where the suppression applies. Omit for { "type": "account" }, which blocks the recipient for every sending domain of the account.

type SuppressionNewParamsScopeType struct{…}

Type SuppressionNewParamsScopeTypeType

Blocks the recipient for every sending domain of the account.

type SuppressionNewParamsScopeObject struct{…}

Type SuppressionNewParamsScopeObjectType

Blocks the recipient only for mail whose envelope MAIL FROM uses value.

Value string

The sending domain to suppress for: the domain part of the envelope MAIL FROM. It is lowercased and trailing dots are removed. Internationalized domains must use the ASCII (punycode) form. Ownership is not checked; a domain the account does not send from never matches.

maxLength1024

ReturnsExpand Collapse

type SuppressionNewResponse struct{…}

ID string

The suppression’s identifier.

formatuuid

Scope SuppressionNewResponseScopeOptional

Where the suppression applies: account for every sending domain of the account, or sending_domain for one envelope MAIL FROM domain.

One of the following:

type SuppressionNewResponseScopeType struct{…}

Type SuppressionNewResponseScopeTypeType

Blocks the recipient for every sending domain of the account.

type SuppressionNewResponseScopeObject struct{…}

Type SuppressionNewResponseScopeObjectType

Blocks the recipient only for mail whose envelope MAIL FROM uses value.

Value string

The sending domain: the domain part of the envelope MAIL FROM, lowercase, without a trailing dot.

maxLength1024

Create account Email Sending suppression

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"),
  )
  suppression, err := client.EmailSending.Suppressions.New(context.TODO(), email_sending.SuppressionNewParams{
    AccountID: cloudflare.F("12345678"),
    Email: cloudflare.F("user@example.com"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", suppression.ID)
}

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "id": "396a5436-d4b0-42a6-b3fc-48e8fa522321",
    "scope": {
      "type": "sending_domain",
      "value": "mail.example.com"
    }
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {}
  ],
  "messages": [
    {}
  ],
  "result": {
    "id": "396a5436-d4b0-42a6-b3fc-48e8fa522321",
    "scope": {
      "type": "sending_domain",
      "value": "mail.example.com"
    }
  },
  "success": true
}