{"openapi":"3.0.0","info":{"description":"Cloudflare Email Routing API — routing rules, destination addresses, settings, suppressions and email sending.","version":[]},"servers":[{"description":"Cloudflare Email Routing API — routing rules, destination addresses, settings, suppressions and email sending.","url":"https://api.apirails.com/cloudflare-email-routing"}],"paths":{"/client/v4/accounts/{account_id}/email/routing/addresses":{"get":{"tags":["Destination Addresses"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"Sorts results in an ascending or descending order.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"page","in":"query","description":"Page number of paginated results.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Maximum number of results per page.","required":false,"schema":{"type":"number","example":""}},{"name":"verified","in":"query","description":"Filter by verified destination addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/addresses"},"summary":"List destination addresses","description":"List destination addresses","security":[{"bearerAuth":[]}]},"post":{"tags":["Destination Addresses"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/addresses"},"summary":"Create a destination address","description":"Create a destination address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The contact email address of the user.","required":true}}},"example":{"email":""}}}}}},"/client/v4/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}":{"get":{"tags":["Destination Addresses"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"destination_address_identifier","in":"path","description":"Destination address identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}"},"summary":"Get a destination address","description":"Get a destination address","security":[{"bearerAuth":[]}]},"patch":{"tags":["Destination Addresses"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"destination_address_identifier","in":"path","description":"Destination address identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}"},"summary":"Update destination address","description":"Update destination address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"status":{"type":"string","description":"Destination address status. Non-admin callers may only set verified addresses back to unverified; setting to verified requires admin privileges.","required":true,"enum":["unverified","verified"]}}},"example":{"status":""}}}}},"delete":{"tags":["Destination Addresses"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"destination_address_identifier","in":"path","description":"Destination address identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/addresses/{destination_address_identifier}"},"summary":"Delete destination address","description":"Delete destination address","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email/routing/rules":{"get":{"tags":["Routing Rules"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"enabled","in":"query","description":"Filter by enabled routing rules.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Page number of paginated results.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Maximum number of results per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/rules"},"summary":"List account routing rules","description":"List account routing rules","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email/routing/rules/plan":{"post":{"tags":["Routing Rules"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/rules/plan"},"summary":"Plan account routing rule changes","description":"Plan account routing rule changes","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"catch_all_rules":{"type":"array","description":"Desired catch-all Email Routing rules managed by the deploying Worker.","items":{"type":"object","properties":{}}},"owner_worker_tag":{"type":"string","description":"Public tag (script_tag) of the Worker that owns this rule. Required when `source` is `wrangler`.","required":true},"rules":{"type":"array","description":"Desired normal Email Routing rules managed by the deploying Worker.","items":{"type":"object","properties":{}}}}},"example":{"catch_all_rules":[],"owner_worker_tag":"","rules":[]}}}}}},"/client/v4/accounts/{account_id}/email/routing/suppression":{"get":{"tags":["Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["email","expires_at","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/suppression"},"summary":"List account email suppressions","description":"List account email suppressions","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/suppression"},"summary":"Create account email suppression","description":"Create account email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email","required":true},"expires_at":{"type":"string","description":"expires at"}}},"example":{"email":"","expires_at":""}}}}}},"/client/v4/accounts/{account_id}/email/routing/suppression/{suppression_id}":{"get":{"tags":["Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/suppression/{suppression_id}"},"summary":"Get account email suppression","description":"Get account email suppression","security":[{"bearerAuth":[]}]},"delete":{"tags":["Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/routing/suppression/{suppression_id}"},"summary":"Delete account email suppression","description":"Delete account email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email/sending/limits":{"get":{"tags":["Sending"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/limits"},"summary":"Get sending limits","description":"Get sending limits","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email/sending/messages/{message_id}":{"get":{"tags":["Sending"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"message_id","in":"path","description":"message id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/messages/{message_id}"},"summary":"Fetch an email message","description":"Fetch an email message","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email/sending/reputation":{"get":{"tags":["Sending"],"parameters":[{"name":"account_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/reputation"},"summary":"Get account reputation","description":"Get account reputation","security":[{"bearerAuth":[]}]}},"/client/v4/accounts/{account_id}/email/sending/send":{"post":{"tags":["Sending"],"parameters":[{"name":"account_id","in":"path","description":"Identifier of the account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/send"},"summary":"Send an email","description":"Send an email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"Plain text body of the email. Provide at least one of text or html (non-empty)."},"attachments":{"type":"array","description":"File attachments and inline images.","items":{"type":"object","properties":{}}},"bcc":{"type":"string","description":"Recipient(s). Optional if cc or bcc is provided. A single email string, a named address object, or an array of either."},"cc":{"type":"string","description":"Recipient(s). Optional if cc or bcc is provided. A single email string, a named address object, or an array of either."},"from":{"type":"string","description":"Sender email address. Either a plain string or an object with address and name.","required":true},"headers":{"type":"object","description":"Custom email headers as key-value pairs.","properties":{}},"html":{"type":"string","description":"HTML body of the email. Provide at least one of text or html (non-empty)."},"reply_to":{"type":"string","description":"Reply-to address. Either a plain string or an object with address and name."},"subject":{"type":"string","description":"Email subject line.","required":true},"to":{"type":"string","description":"Recipient(s). Optional if cc or bcc is provided. A single email string, a named address object, or an array of either."}}},"example":{"text":"","attachments":[],"bcc":"","cc":"","from":"","headers":{},"html":"","reply_to":"","subject":"","to":""}}}}}},"/client/v4/accounts/{account_id}/email/sending/send_raw":{"post":{"tags":["Sending"],"parameters":[{"name":"account_id","in":"path","description":"Identifier of the account.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/send_raw"},"summary":"Send a raw MIME email","description":"Send a raw MIME email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"from":{"type":"string","description":"Sender email address.","required":true},"mime_message":{"type":"string","description":"The full MIME-encoded email message. Should include standard RFC 5322 headers such as From, To, Subject, and Content-Type. The from and recipients fields in the request body control SMTP envelope routing; the From and To headers in the MIME message control what the recipient's email client displays.","required":true},"recipients":{"type":"array","description":"List of recipient email addresses.","required":true,"items":{"type":"string"}}}},"example":{"from":"","mime_message":"","recipients":[]}}}}}},"/client/v4/accounts/{account_id}/email/sending/suppression":{"get":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["email","expires_at","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppression"},"summary":"List account email suppressions","description":"List account email suppressions","security":[{"bearerAuth":[]}]},"post":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppression"},"summary":"Create account email suppression","description":"Create account email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email","required":true},"expires_at":{"type":"string","description":"expires at"}}},"example":{"email":"","expires_at":""}}}}}},"/client/v4/accounts/{account_id}/email/sending/suppression/{suppression_id}":{"get":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppression/{suppression_id}"},"summary":"Get account email suppression","description":"Get account email suppression","security":[{"bearerAuth":[]}]},"delete":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppression/{suppression_id}"},"summary":"Delete account email suppression","description":"Delete account email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/accounts/{account_id}/email/sending/suppressions":{"get":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Opaque pagination cursor returned as `result_info.next_cursor`. It carries the filters that produced it.","required":false,"schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"Exact email-address filter.","required":false,"schema":{"type":"string","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}},{"name":"reason","in":"query","description":"reason","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["manual","complaint","hard_bounce","soft_bounce","policy"]}}},{"name":"search","in":"query","description":"A complete address is an exact match; a value ending in `@` matches that username across every domain. Prefix searches may return short intermediate pages while the bounded account scan advances.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppressions"},"summary":"List account Email Sending suppressions","description":"List account Email Sending suppressions","security":[{"bearerAuth":[]}]},"post":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppressions"},"summary":"Create account Email Sending suppression","description":"Create account Email Sending suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email","required":true},"expires_at":{"type":"string","description":"expires at"},"note":{"type":"string","description":"note"}}},"example":{"email":"","expires_at":"","note":""}}}}}},"/client/v4/accounts/{account_id}/email/sending/suppressions/bulk":{"post":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppressions/bulk"},"summary":"Bulk import account Email Sending suppressions","description":"Bulk import account Email Sending suppressions","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"items":{"type":"array","description":"items","required":true,"items":{"type":"object","properties":{}}}}},"example":{"items":[]}}}}}},"/client/v4/accounts/{account_id}/email/sending/suppressions/{suppression_id}":{"get":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppressions/{suppression_id}"},"summary":"Get account Email Sending suppression","description":"Get account Email Sending suppression","security":[{"bearerAuth":[]}]},"patch":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppressions/{suppression_id}"},"summary":"Update account Email Sending suppression","description":"Update account Email Sending suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"expires_at":{"type":"string","description":"New expiry. Send `null` to make the suppression permanent; omit to leave it unchanged."},"note":{"type":"string","description":"Replacement advisory note. Send an empty string to clear it; omit to leave it unchanged."}}},"example":{"expires_at":"","note":""}}}}},"delete":{"tags":["Sending Suppressions"],"parameters":[{"name":"account_id","in":"path","description":"account id","required":true,"schema":{"type":"string","example":""}},{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/accounts/{account_id}/email/sending/suppressions/{suppression_id}"},"summary":"Delete account Email Sending suppression","description":"Delete account Email Sending suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/zones/{zone_id}/email/routing":{"get":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing"},"summary":"Get Email Routing settings","description":"Get Email Routing settings","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing"},"summary":"Update Email Routing settings","description":"Update Email Routing settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled":{"type":"boolean","description":"State of your zone Email Routing settings. No-op on this endpoint - use `POST`/`DELETE /zones/{zone_id}/email/routing/dns`.","enum":[true,false]},"skip_wizard":{"type":"boolean","description":"Flag to check if the user skipped the configuration wizard.","enum":[true,false]},"support_subaddress":{"type":"boolean","description":"Whether subaddressing (plus-addressing) is honored when matching incoming mail against routing rules.","enum":[true,false]}}},"example":{"enabled":"","skip_wizard":"","support_subaddress":""}}}}},"patch":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing"},"summary":"Update Email Routing settings","description":"Update Email Routing settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"enabled":{"type":"boolean","description":"State of your zone Email Routing settings. No-op on this endpoint - use `POST`/`DELETE /zones/{zone_id}/email/routing/dns`.","enum":[true,false]},"skip_wizard":{"type":"boolean","description":"Flag to check if the user skipped the configuration wizard.","enum":[true,false]},"support_subaddress":{"type":"boolean","description":"Whether subaddressing (plus-addressing) is honored when matching incoming mail against routing rules.","enum":[true,false]}}},"example":{"enabled":"","skip_wizard":"","support_subaddress":""}}}}}},"/client/v4/zones/{zone_id}/email/routing/disable":{"post":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/disable"},"summary":"Disable Email Routing","description":"Disable Email Routing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/zones/{zone_id}/email/routing/dns":{"get":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"subdomain","in":"query","description":"Domain of your zone.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/dns"},"summary":"Email Routing - DNS settings","description":"Email Routing - DNS settings","security":[{"bearerAuth":[]}]},"post":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/dns"},"summary":"Enable Email Routing","description":"Enable Email Routing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Domain of your zone."}}},"example":{"name":""}}}}},"patch":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/dns"},"summary":"Unlock Email Routing","description":"Unlock Email Routing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Domain of your zone."}}},"example":{"name":""}}}}},"delete":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/dns"},"summary":"Disable Email Routing","description":"Disable Email Routing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Domain of your zone."}}},"example":{"name":""}}}}}},"/client/v4/zones/{zone_id}/email/routing/enable":{"post":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/enable"},"summary":"Enable Email Routing","description":"Enable Email Routing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/zones/{zone_id}/email/routing/rules":{"get":{"tags":["Routing Rules"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"enabled","in":"query","description":"Filter by enabled routing rules.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"page","in":"query","description":"Page number of paginated results.","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"Maximum number of results per page.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/rules"},"summary":"List routing rules","description":"List routing rules","security":[{"bearerAuth":[]}]},"post":{"tags":["Routing Rules"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/rules"},"summary":"Create routing rule","description":"Create routing rule","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"actions":{"type":"array","description":"List actions patterns.","required":true,"items":{"type":"object","properties":{}}},"enabled":{"type":"boolean","description":"Routing rule status.","enum":[true,false]},"matchers":{"type":"array","description":"Matching patterns to forward to your actions.","required":true,"items":{"type":"object","properties":{}}},"name":{"type":"string","description":"Routing rule name."},"owner_worker_tag":{"type":"string","description":"Public tag (script_tag) of the Worker that owns this rule. Required when `source` is `wrangler`."},"priority":{"type":"number","description":"Priority of the routing rule."},"source":{"type":"string","description":"Who manages the rule. `api` covers dashboard, generic API, and Terraform; `wrangler` means the rule is managed by a Worker's wrangler.jsonc. Defaults to `api` when omitted on write.","enum":["api","wrangler"]}}},"example":{"actions":[],"enabled":"","matchers":[],"name":"","owner_worker_tag":"","priority":"","source":""}}}}}},"/client/v4/zones/{zone_id}/email/routing/rules/catch_all":{"get":{"tags":["Routing Rules"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/rules/catch_all"},"summary":"Get catch-all rule","description":"Get catch-all rule","security":[{"bearerAuth":[]}]},"put":{"tags":["Routing Rules"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/rules/catch_all"},"summary":"Update catch-all rule","description":"Update catch-all rule","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"actions":{"type":"array","description":"List actions for the catch-all routing rule.","required":true,"items":{"type":"object","properties":{}}},"enabled":{"type":"boolean","description":"Routing rule status.","enum":[true,false]},"matchers":{"type":"array","description":"List of matchers for the catch-all routing rule.","required":true,"items":{"type":"object","properties":{}}},"name":{"type":"string","description":"Routing rule name."},"owner_worker_tag":{"type":"string","description":"Public tag (script_tag) of the Worker that owns this rule. Required when `source` is `wrangler`."},"source":{"type":"string","description":"Who manages the rule. `api` covers dashboard, generic API, and Terraform; `wrangler` means the rule is managed by a Worker's wrangler.jsonc. Defaults to `api` when omitted on write.","enum":["api","wrangler"]}}},"example":{"actions":[],"enabled":"","matchers":[],"name":"","owner_worker_tag":"","source":""}}}}}},"/client/v4/zones/{zone_id}/email/routing/rules/{rule_identifier}":{"get":{"tags":["Routing Rules"],"parameters":[{"name":"rule_identifier","in":"path","description":"Routing rule identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/rules/{rule_identifier}"},"summary":"Get routing rule","description":"Get routing rule","security":[{"bearerAuth":[]}]},"put":{"tags":["Routing Rules"],"parameters":[{"name":"rule_identifier","in":"path","description":"Routing rule identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/rules/{rule_identifier}"},"summary":"Update routing rule","description":"Update routing rule","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"actions":{"type":"array","description":"List actions patterns.","required":true,"items":{"type":"object","properties":{}}},"enabled":{"type":"boolean","description":"Routing rule status.","enum":[true,false]},"matchers":{"type":"array","description":"Matching patterns to forward to your actions.","required":true,"items":{"type":"object","properties":{}}},"name":{"type":"string","description":"Routing rule name."},"owner_worker_tag":{"type":"string","description":"Public tag (script_tag) of the Worker that owns this rule. Required when `source` is `wrangler`."},"priority":{"type":"number","description":"Priority of the routing rule."},"source":{"type":"string","description":"Who manages the rule. `api` covers dashboard, generic API, and Terraform; `wrangler` means the rule is managed by a Worker's wrangler.jsonc. Defaults to `api` when omitted on write.","enum":["api","wrangler"]}}},"example":{"actions":[],"enabled":"","matchers":[],"name":"","owner_worker_tag":"","priority":"","source":""}}}}},"delete":{"tags":["Routing Rules"],"parameters":[{"name":"rule_identifier","in":"path","description":"Routing rule identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/rules/{rule_identifier}"},"summary":"Delete routing rule","description":"Delete routing rule","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/zones/{zone_id}/email/routing/suppression":{"get":{"tags":["Suppressions"],"parameters":[{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["email","expires_at","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/suppression"},"summary":"List zone email suppressions","description":"List zone email suppressions","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/suppression"},"summary":"Create zone email suppression","description":"Create zone email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email","required":true},"expires_at":{"type":"string","description":"expires at"}}},"example":{"email":"","expires_at":""}}}}}},"/client/v4/zones/{zone_id}/email/routing/suppression/{suppression_id}":{"get":{"tags":["Suppressions"],"parameters":[{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/suppression/{suppression_id}"},"summary":"Get zone email suppression","description":"Get zone email suppression","security":[{"bearerAuth":[]}]},"delete":{"tags":["Suppressions"],"parameters":[{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/suppression/{suppression_id}"},"summary":"Delete zone email suppression","description":"Delete zone email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/zones/{zone_id}/email/routing/unlock":{"post":{"tags":["Settings"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/routing/unlock"},"summary":"Unlock Email Routing","description":"Unlock Email Routing","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Domain of your zone."}}},"example":{"name":""}}}}}},"/client/v4/zones/{zone_id}/email/sending/subdomains":{"get":{"tags":["Sending Subdomains"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains"},"summary":"List sending subdomains","description":"List sending subdomains","security":[{"bearerAuth":[]}]},"post":{"tags":["Sending Subdomains"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains"},"summary":"Create a sending subdomain","description":"Create a sending subdomain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The domain name within the zone. A wildcard is allowed only as the complete leftmost label (`*.example.com`) and requires the account wildcard Email Sending entitlement.","required":true}}},"example":{"name":""}}}}}},"/client/v4/zones/{zone_id}/email/sending/subdomains/preview":{"post":{"tags":["Sending Subdomains"],"parameters":[{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/preview"},"summary":"Preview sending subdomain DNS","description":"Preview sending subdomain DNS","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"The domain name within the zone. A wildcard is allowed only as the complete leftmost label (`*.example.com`) and requires the account wildcard Email Sending entitlement.","required":true}}},"example":{"name":""}}}}}},"/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}":{"get":{"tags":["Sending Subdomains"],"parameters":[{"name":"subdomain_id","in":"path","description":"Sending subdomain identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}"},"summary":"Get a sending subdomain","description":"Get a sending subdomain","security":[{"bearerAuth":[]}]},"patch":{"tags":["Sending Subdomains"],"parameters":[{"name":"subdomain_id","in":"path","description":"Sending subdomain identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}"},"summary":"Update a sending subdomain","description":"Update a sending subdomain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"drop_suppressed_recipients":{"type":"boolean","description":"Whether a send request that includes a recipient suppressed on this subdomain drops that recipient and still delivers to the rest, instead of failing the entire request.","enum":[true,false]},"preview_enabled":{"type":"boolean","description":"Whether sent messages from this subdomain can be previewed in the activity log.","enum":[true,false]}}},"example":{"drop_suppressed_recipients":"","preview_enabled":""}}}}},"delete":{"tags":["Sending Subdomains"],"parameters":[{"name":"subdomain_id","in":"path","description":"Sending subdomain identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}"},"summary":"Delete a sending subdomain","description":"Delete a sending subdomain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns":{"get":{"tags":["Sending Subdomains"],"parameters":[{"name":"subdomain_id","in":"path","description":"Sending subdomain identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns"},"summary":"Get sending subdomain DNS records","description":"Get sending subdomain DNS records","security":[{"bearerAuth":[]}]},"post":{"tags":["Sending Subdomains"],"parameters":[{"name":"subdomain_id","in":"path","description":"Sending subdomain identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns"},"summary":"Fix sending subdomain DNS records","description":"Fix sending subdomain DNS records","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns/status":{"get":{"tags":["Sending Subdomains"],"parameters":[{"name":"subdomain_id","in":"path","description":"Sending subdomain identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/dns/status"},"summary":"Get sending subdomain DNS status","description":"Get sending subdomain DNS status","security":[{"bearerAuth":[]}]}},"/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/reputation/complaints":{"get":{"tags":["Sending Subdomains"],"parameters":[{"name":"subdomain_id","in":"path","description":"Sending subdomain identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"Identifier.","required":true,"schema":{"type":"string","example":""}},{"name":"end_at","in":"query","description":"end at","required":true,"schema":{"type":"string","example":""}},{"name":"start_at","in":"query","description":"start at","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/subdomains/{subdomain_id}/reputation/complaints"},"summary":"Get sending subdomain complaint count","description":"Get sending subdomain complaint count","security":[{"bearerAuth":[]}]}},"/client/v4/zones/{zone_id}/email/sending/suppression":{"get":{"tags":["Sending Suppressions"],"parameters":[{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"order","in":"query","description":"order","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["email","expires_at","created_at"]}}},{"name":"page","in":"query","description":"page","required":false,"schema":{"type":"number","example":""}},{"name":"per_page","in":"query","description":"per page","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/suppression"},"summary":"List zone email suppressions","description":"List zone email suppressions","security":[{"bearerAuth":[]}]},"post":{"tags":["Sending Suppressions"],"parameters":[{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/suppression"},"summary":"Create zone email suppression","description":"Create zone email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"email","required":true},"expires_at":{"type":"string","description":"expires at"}}},"example":{"email":"","expires_at":""}}}}}},"/client/v4/zones/{zone_id}/email/sending/suppression/{suppression_id}":{"get":{"tags":["Sending Suppressions"],"parameters":[{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/suppression/{suppression_id}"},"summary":"Get zone email suppression","description":"Get zone email suppression","security":[{"bearerAuth":[]}]},"delete":{"tags":["Sending Suppressions"],"parameters":[{"name":"suppression_id","in":"path","description":"suppression id","required":true,"schema":{"type":"string","example":""}},{"name":"zone_id","in":"path","description":"zone id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.cloudflare.com/api/resources/email-routing/","api_endpoint":"https://api.cloudflare.com/client/v4/zones/{zone_id}/email/sending/suppression/{suppression_id}"},"summary":"Delete zone email suppression","description":"Delete zone email suppression","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}