DevicePreviewsController

Create a new device preview run for an email

post/emails/{emailId}/device-previews

Request

  • Base URL: https://api.mailslurp.com
  • URL: https://api.mailslurp.com/emails/{emailId}/device-previews
  • Auth: API key in header x-api-key

Path parameters

emailIdstring uuid required

Request body

targetsstring[] nullable

Optional device preview target keys to request for rendering. Null leaves target selection to service configuration. Values are forwarded to ESP so newly deployed targets can be used before this API's enum list is updated.

allTargetsboolean nullable

When true, ask the renderer to include every currently configured target. Cannot be combined with targets.

folderIdstring uuid nullable

Optional folder for organizing the render. Missing folders leave the render unfiled.

Example request

{
  "targets": [
    "apple_mail_macos"
  ]
}

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.