> ## Documentation Index
> Fetch the complete documentation index at: https://snowseo.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Email a Report

> Email a report as a PDF attachment to one or more recipients.

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](https://snowseo.com/docs/api-reference/endpoints/report-sharing.md):

| Field | Description |
| - | - |
| `pages` | Required. Array of rendered pages, each with an `image` (data URL) and optional `branding` box (`x`, `y`, `w`, `h`, `disableWhiteLabel`) |
| `pageWidth` | Required. Page width in pixels |
| `pageHeight` | Required. Page height in pixels |
| `orientation` | Optional `portrait` or `landscape` |
| `title` | Report title used for the PDF filename and metadata |
| `author` | Optional author metadata |

In addition, the body accepts:

| Field | Description |
| - | - |
| `recipients` | Required. 1–10 valid email addresses (deduplicated, lowercased) |
| `message` | Optional note included in the email body |

Returns `{ sent, failed }` - arrays of the recipient addresses that succeeded or failed.

> [!TIP]
>
> This route is rate-limited more tightly than the others (roughly 10 requests/minute per team) to protect email deliverability.


## OpenAPI

````yaml POST /v3/reports/{id}/share/email
openapi: 3.0.0
info:
  title: SnowSEO API
  description: API documentation for SnowSEO
  version: 1.0.0
servers:
  - url: https://api.snowseo.com
    description: Production server
security:
  - bearerAuth: []
  - apiKey: []
externalDocs:
  url: https://snowseo.com/docs
  description: Find more info here
paths:
  /v3/reports/{id}/share/email:
    post:
      tags:
        - Reports
      summary: Email a report as a PDF
      parameters:
        - schema:
            type: string
          in: path
          name: id
          required: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - recipients
                - pages
                - pageWidth
                - pageHeight
              properties:
                teamId:
                  type: string
                recipients:
                  type: array
                  items:
                    type: string
                  description: Up to 10 email addresses.
                message:
                  type: string
                pages:
                  type: array
                  items:
                    type: object
                    additionalProperties: true
                    properties:
                      image:
                        type: string
                        description: The rendered page as an image data URL.
                      branding:
                        type: object
                        additionalProperties: true
                pageWidth:
                  type: number
                  description: Page width.
                pageHeight:
                  type: number
                  description: Page height.
                orientation:
                  type: string
                  enum:
                    - portrait
                    - landscape
                title:
                  type: string
                  description: Document title, also used for the PDF filename.
                author:
                  type: string
                  description: Author metadata.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
                properties:
                  sent:
                    type: array
                    items:
                      type: string
                  failed:
                    type: array
                    items:
                      type: string
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Your SnowSEO API key (sk_...).
    apiKey:
      type: apiKey
      name: x-api-key
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.