This method is provided as an optional performance enhancement, typically useful before embedding a set of previews within a browser, where connection limits might otherwise delay the start of capture of some previews. For more detail on when this might be useful see performance.

The method does not block while capture occurs, a 202 Accepted response is returned immediately.

Note that should capture failure occur for a preview, it will only be discovered when the preview is later requested. Request errors, for instance attempting to prefetch an invalid client, will result in a 400 Bad Request however.

Capture configurationDescription
clientrequired

an identifier present in available clients
imagesoptional

one of allowed (default), blocked

Refer to configurations to determine what's valid for for each client
orientationoptional

one of horizontal, vertical (default)

Refer to configurations to determine what's valid for for each client
Errors
400 Bad Request - if the request body is malformed, or if any requested capture configuration is invalid
404 Not Found - when the email_guid is not found. This can occur when email assets or stored captures have expired having exceeded their lifetime
JSON response body attributesDescription
configurationsConfirmation of capture configurations that will be prefetched.
Language
Click Try It! to start a request and see the response here!