Reports

Email a report as a PDF

Changed on
post/v3/reports/{id}/share/email

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/reports/{id}/share/email
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Request body

teamIdstring
recipientsstring[] required

Up to 10 email addresses.

messagestring
pageWidthnumber required

Page width.

pageHeightnumber required

Page height.

orientation'portrait' | 'landscape'
titlestring

Document title, also used for the PDF filename.

authorstring

Author metadata.

Response

Default Response

sentstring[]
failedstring[]

Changes

  • 3976341798f4Revision changes
    • breaking

      added required request body

    • info

      api tag Reports added

    • info

      added the media type application/json for the response with the status