Customer.io
v1.0.0
OpenAPI 3.1.0

Get a preview screenshot

US region

Client Libraries
Shell Curl

Get a preview screenshot

​

Returns the image bytes for a single preview job, proxied from the vendor. The response's content type matches whatever the vendor sent for that capture, which isn't always PNG, and the Content-Disposition filename's extension matches it. You can also use the URL paths in the response of Get an inbox preview job to complete this request.

Path Parameters
  • id
    Type: string Format: uuid
    required

    The UUID of the email. If your email has translations, this is the ID of a specific language variant.

  • run_id
    Type: integer
    required

    The ID of the inbox preview job, returned by Send for inbox previews.

  • client_id
    Type: string
    required

    The device identifier for the capture, matching a value from client_ids in the response of Send for inbox previews.

Query Parameters
  • variant
    Type: string enum

    The image to return.

    values
    • screenshot
    • thumbnail
    • full_thumbnail
  • key
    Type: string

    Only applies when variant is screenshot. Match this to a key in that tile's screenshots object from Get an inbox preview job—most devices only have default, but some carry extra vendor-defined captures, like an image-blocking render.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v1/design_studio/emails/{id}/inbox_previews/{run_id}/captures/{client_id}
curl 'https://api.customer.io/v1/design_studio/emails/123e4567-e89b-12d3-a456-426614174000/inbox_previews/1/captures/{client_id}'

@filename

Image bytes for the requested capture, in whatever format the vendor sent it.