Skip to content
Documentation

Render

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

Renders the selected components of an email design system

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Request Body

Section titled “Request Body ”
object
email_design_system_id
required

ID of the email design system

integer
brand_profile_id

ID of the brand profile

integer
content
required
object
subject
required

Subject of the email

string
preheader
required

Preheader of the email

string
container_component_instance
required
object
component_id
required
integer
field_values
object
key
additional properties
One of:
string
component_instances
required
Array<object>
object
component_id
required
integer
field_values
object
key
additional properties
One of:
string

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful

object
html

HTML output of the rendered components

string
created_at
string format: date-time
Example
2023-08-23T10:30:00.000Z

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

404

Section titled “404 ”

Not Found

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

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