Skip to content

Render Email Design System

POST
/api/v1/workspaces/{workspace_id}/email_design_systems/{emailDesignSystemId}/renders
curl --request POST \
--url https://example.com/%7B%7Bapp_url%7D/api/v1/workspaces/1/email_design_systems/1/renders \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "email_design_system": {}, "components": [ {} ], "container_component": {} }'

Renders an email design system.

  • OAuth2
    email_design_systems:read
workspace_id
required
integer

Workspace ID

emailDesignSystemId
required
integer

Email Design System ID

Media typeapplication/json
object
email_design_system
required
object
key
additional properties
any
components
required
Array<object>
object
key
additional properties
any
container_component
required
object
key
additional properties
any
Examplegenerated
{
"email_design_system": {},
"components": [
{}
],
"container_component": {}
}

Successful

Media typeapplication/json
object
html
string
Example
{
"html": "<html><body><h1>Hello, world!</h1></body></html>"
}

Unauthorized

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

Forbidden

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

Validation Error

Media typeapplication/json
object
message
required
string
errors
required
object
key
additional properties
any
Example
{
"message": "Validation failed"
}