Skip to content
Documentation

Create Rendered Asset

POST
/api/v1/workspaces/{workspace_id}/emails/{email_id}/rendered_assets
curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/emails/1/rendered_assets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "format": "pdf", "device_type": "desktop", "specs": [ { "locale": "en-US", "conditional_selections": [ { "conditional_id": 12345, "mode": "all", "branch_key": "gold" } ] } ] }'

Creates a new rendered asset (PDF or PNG) from an email.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace_id
required
integer

Workspace ID

email_id
required
integer

Email ID

Request Body

Section titled “Request Body”
Media typeapplication/json
object
format
required

The output format.

string
Allowed values: pdf png
device_type
required

The device viewport to render with.

string
Allowed values: desktop mobile
specs
required

Array of render specifications.

Array<object>
object
locale
required
string
Example
en-US
conditional_selections
Array<object> | null
object
conditional_id
required

The id of a saved conditional, or an inline conditional addressed by its owner: inline:<component_instance_id> for a component instance, or inline:subject / inline:preheader.

integer | string
Example
12345
mode
required
string
Allowed values: all none branch
Example
branch
branch_key
string | null
Example
gold

Responses

Section titled “Responses”

201

Section titled “201”

Successful

Media typeapplication/json
object
id
required
integer
organization_id
required
integer
workspace_id
required
integer
email_id
required
integer
format
required
string
Allowed values: pdf png
device_type
required
string
Allowed values: desktop mobile
status
required
string
Allowed values: in_progress completed failed
specs
required
Array<object>
object
locale
required
string
conditional_selections
Array<object> | null
object
conditional_id
required

The id of a saved conditional, or an inline conditional addressed by its owner: inline:<component_instance_id> for a component instance, or inline:subject / inline:preheader.

integer | string
mode
required
string
Allowed values: all none branch
branch_key
string | null
errors_data
required
object | null
download_url
required
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example
{
  "id": 12345,
  "organization_id": 12345,
  "workspace_id": 12345,
  "email_id": 12345,
  "format": "pdf",
  "device_type": "desktop",
  "status": "in_progress",
  "specs": [
    {
      "locale": "en-US",
      "conditional_selections": [
        {
          "conditional_id": 12345,
          "mode": "all",
          "branch_key": "gold"
        }
      ]
    }
  ],
  "download_url": "https://www.example.com/download.pdf",
  "created_at": "2023-08-23T10:30:00.000Z",
  "updated_at": "2023-08-23T10:30:00.000Z"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
message
required
string
Example
{
  "message": "Record not found"
}

422

Section titled “422”

Unprocessable Entity

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}