Batch Block Senders

POST /accounts/{account_id}/email-security/settings/block_senders/batch

Copy endpoint

https://api.cloudflare.com/client/v4

Send a Batch of Block Senders API calls to be executed together.

Parameters

path Path Parameters

Name	Type
`account_id` required	type EmailSecurityAccountId = string

Request Body

application/json required

{
deletes: { id: number; }[];
patches: (

EmailSecurityUpdateBlockedSender

interface EmailSecurityUpdateBlockedSender {
comments?: string | null;
is_regex?: boolean | null;
pattern?: string | null;
pattern_type?: string & EmailSecurityPatternType | null & EmailSecurityPatternType;
}

& { id:

EmailSecurityBlockedSenderId

The unique identifier for the allow policy.

type EmailSecurityBlockedSenderId = number

; })[];
posts:

EmailSecurityCreateBlockedSender

interface EmailSecurityCreateBlockedSender {
comments?: string | null;
is_regex: boolean;
pattern: string;
pattern_type: EmailSecurityPatternType;
}

[];
puts: (

EmailSecurityCreateBlockedSender

interface EmailSecurityCreateBlockedSender {
comments?: string | null;
is_regex: boolean;
pattern: string;
pattern_type: EmailSecurityPatternType;
}

& { id:

EmailSecurityBlockedSenderId

The unique identifier for the allow policy.

type EmailSecurityBlockedSenderId = number

; })[];
}

Responses

200 application/json

interface EmailSecurityApiResponseCommon {
errors:

EmailSecurityMessage

interface EmailSecurityMessage {
code: number;
message: string;
}

[];
messages:

EmailSecurityMessage

interface EmailSecurityMessage {
code: number;
message: string;
}

[];
success: boolean;
} & { result: {
deletes: { id: number; }[];
patches:

EmailSecurityBlockedSender

interface EmailSecurityBlockedSender {
comments?: string | null;
is_regex: boolean;
pattern: string;
pattern_type: EmailSecurityPatternType;
created_at: string;
id: EmailSecurityBlockedSenderId;
last_modified: string;
}

[];
posts:

EmailSecurityBlockedSender

[];
puts:

EmailSecurityBlockedSender

[];
}; }

Client Errors

4XX application/json

Client Error

{
errors:

EmailSecurityMessage

interface EmailSecurityMessage {
code: number;
message: string;
}

[];
messages:

EmailSecurityMessage

interface EmailSecurityMessage {
code: number;
message: string;
}

[];
result: {} | null;
success: boolean;
}