Render

POST

/api/v1/workspaces/{workspace_id}/renders

curl --request POST \
  --url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/renders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email_design_system_id": 1, "brand_profile_id": 1, "locale": "en-US", "email_content": { "subject": { "conditional_id": 1, "branch_content": { "additionalProperty": { "additionalProperty": "My Email Subject in a Specific Locale" } } }, "preheader": { "conditional_id": 1, "branch_content": { "additionalProperty": { "additionalProperty": "My Email Preheader in a Specific Locale" } } }, "container_component_instance": { "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed", "name": "My Component", "component_name": "Headline", "conditional_id": 1, "field_values": { "additionalProperty": { "additionalProperty": { "additionalProperty": { "value": "example", "link_tracking_parameters": { "additionalProperty": "example" } } } } }, "hidden_from_locales": { "additionalProperty": true }, "link_tracking_parameters": { "branch_content": { "additionalProperty": { "additionalProperty": { "additionalProperty": "example" } } } } }, "component_instances": [ { "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed", "name": "My Component", "component_name": "Headline", "conditional_id": 1, "field_values": { "additionalProperty": { "additionalProperty": { "additionalProperty": { "value": "example", "link_tracking_parameters": { "additionalProperty": "example" } } } } }, "hidden_from_locales": { "additionalProperty": true }, "link_tracking_parameters": { "branch_content": { "additionalProperty": { "additionalProperty": { "additionalProperty": "example" } } } } } ], "global_link_tracking_parameters": { "additionalProperty": "example" } } }'

Renders the selected components of an email design system

Authorizations

• OAuth2
  renders:create

Parameters

Path Parameters

workspace_id

required

integer

Workspace ID

Request Body

Media typeapplication/json

object

email_design_system_id

required

ID of the email design system

integer

brand_profile_id

ID of the brand profile

integer

locale

required

Locale to render.

string

Example

en-US

email_content

required

object

subject

required

object

conditional_id

The ID of the conditional applied to this content. When set, the content has a separate variant for each branch of the conditional.

integer

nullable

branch_content

required

Content organized by branch key, then by locale code.

object

key

additional properties

Localized email subject, keyed by BCP47 locale

object

key

additional properties

string

Example

My Email Subject in a Specific Locale

preheader

required

object

conditional_id

The ID of the conditional applied to this content. When set, the content has a separate variant for each branch of the conditional.

integer

nullable

branch_content

required

Content organized by branch key, then by locale code.

object

key

additional properties

Localized email preheader, keyed by BCP47 locale

object

key

additional properties

string

Example

My Email Preheader in a Specific Locale

container_component_instance

required

object

id

required

string

Example

bd1c1b82-1a7b-4f0f-b079-30c1d4189bed

name

string

Example

My Component

component_name

required

The name of the component definition this instance is based on.

string

Example

Headline

conditional_id

The ID of the conditional applied to this component instance. When set, the component renders a separate variant for each branch of the conditional.

integer

nullable

Example

1

field_values

Field values organized by branch key.

object

key

additional properties

Field values organized by locale code.

object

key

additional properties

Field values keyed by liquid variable name.

object

key

additional properties

object

value

required

One of:

string

string

number

number

boolean

boolean

link_tracking_parameters

Link tracking parameter values specific to this field.

object

key

additional properties

string

hidden_from_locales

A map of locale codes to boolean values indicating whether this component instance is hidden for that locale.

object

key

additional properties

boolean

Example

true

link_tracking_parameters

object

branch_content

Per-component-instance link tracking parameter values, organized by branch key, then by locale code.

object

key

additional properties

object

key

additional properties

A map of link tracking parameter names to their values for this component instance.

object

key

additional properties

string

component_instances

required

Array<object>

object

id

required

string

Example

bd1c1b82-1a7b-4f0f-b079-30c1d4189bed

name

string

Example

My Component

component_name

required

The name of the component definition this instance is based on.

string

Example

Headline

conditional_id

The ID of the conditional applied to this component instance. When set, the component renders a separate variant for each branch of the conditional.

integer

nullable

Example

1

field_values

Field values organized by branch key.

object

key

additional properties

Field values organized by locale code.

object

key

additional properties

Field values keyed by liquid variable name.

object

key

additional properties

object

value

required

One of:

string

string

number

number

boolean

boolean

link_tracking_parameters

Link tracking parameter values specific to this field.

object

key

additional properties

string

hidden_from_locales

A map of locale codes to boolean values indicating whether this component instance is hidden for that locale.

object

key

additional properties

boolean

Example

true

link_tracking_parameters

object

branch_content

Per-component-instance link tracking parameter values, organized by branch key, then by locale code.

object

key

additional properties

object

key

additional properties

A map of link tracking parameter names to their values for this component instance.

object

key

additional properties

string

global_link_tracking_parameters

A map of link tracking parameter names to their values for this component instance.

object

key

additional properties

string

Responses

201

Successful

Media typeapplication/json

object

html

required

The rendered HTML of the email

string

subject

required

The rendered subject line of the email

string

preheader

required

The rendered preheader text of the email

string

Example

{
  "html": "<html><body><h1>Hello, world!</h1></body></html>",
  "subject": "Hello, world!",
  "preheader": "Hello, world!"
}

401

Unauthorized

Media typeapplication/json

object

message

required

string

Example

{
  "message": "Record not found"
}

403

Forbidden

Media typeapplication/json

object

message

required

string

Example

{
  "message": "Record not found"
}

404

Not Found

Media typeapplication/json

object

message

required

string

Example

{
  "message": "Record not found"
}

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."
    ]
  }
}