Skip to main content
POST
Email a report as a PDF
Render the report to a PDF and email it as an attachment to one or more recipients, using the organization’s white-label email branding when configured. Each delivered send is logged to the org “Reports Sent” KPI. The body takes the rendered-page payload used by Report Sharing & Delivery: In addition, the body accepts: Returns { sent, failed } - arrays of the recipient addresses that succeeded or failed.
This route is rate-limited more tightly than the others (roughly 10 requests/minute per team) to protect email deliverability.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Path Parameters

id
string
required

Body

application/json
recipients
string[]
required

Up to 10 email addresses.

pages
object[]
required
pageWidth
number
required

Page width.

pageHeight
number
required

Page height.

teamId
string
message
string
orientation
enum<string>
Available options:
portrait,
landscape
title
string

Document title, also used for the PDF filename.

author
string

Author metadata.

Response

200 - application/json

Default Response

sent
string[]
failed
string[]