Skip to content
Documentation

Import Email Design System from JSON

POST
/api/v1/workspaces/{workspace_id}/email_design_systems/import

Imports an email design system from JSON data.

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
required
object
name
required
string
Example
My Email Design System
description
required
string
nullable
Example
My Email Design System
design_tokens
required
object
key
additional properties
any
Example
{
  "primary_button_color": "#007bff",
  "secondary_button_color": "#6c757d"
}
custom_styles
required
Array<object>
nullable
object
style
required
string
Example
background-color: yellow; font-weight: bold;
name
required
string
Example
highlight
label
required
string
Example
Highlight
container_component
required
object
name
required
string
Example
MyComponent
label
required
string
Example
My Component
description
required
string
nullable
Example
A hero banner image with a headline and image, body text and a call to action button.
container
boolean
nullable
template
required
string
Example
<div>My Component</div>
field_definitions
required
Array
One of:
object
type
required
string
Allowed values: text
label
required
string
group
string
nullable
liquid_variable
required
string
visible_if
string
default_value
required
string
validations
object
min_length
integer
max_length
integer
must_not_be_blank
boolean
must_not_be_default
boolean
hint
string
hidden_in_editor
boolean
hidden_from_ai
boolean
feed_field_name
string
nullable
position
required
integer
nullable
Example
1
feed_id
required
integer
nullable
Example
12345
deprecated
required
boolean
components
required
Array<object>
object
name
required
string
Example
MyComponent
label
required
string
Example
My Component
description
required
string
nullable
Example
A hero banner image with a headline and image, body text and a call to action button.
container
boolean
nullable
template
required
string
Example
<div>My Component</div>
field_definitions
required
Array
One of:
object
type
required
string
Allowed values: text
label
required
string
group
string
nullable
liquid_variable
required
string
visible_if
string
default_value
required
string
validations
object
min_length
integer
max_length
integer
must_not_be_blank
boolean
must_not_be_default
boolean
hint
string
hidden_in_editor
boolean
hidden_from_ai
boolean
feed_field_name
string
nullable
position
required
integer
nullable
Example
1
feed_id
required
integer
nullable
Example
12345
deprecated
required
boolean

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Successful

object
id
required
integer
Example
12345
name
required
string
Example
My Email Design System
description
string
Example
My Email Design System
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
string format: date-time
Example
2023-08-23T10:30:00.000Z
organization_id
required
integer
Example
12345
workspace_id
required
integer
Example
12345
screenshot_url
required
string
Example
https://www.example.com/screenshot.png
upload_status
required
string
Allowed values: ready processing
Example
success
create_with_ai
required
boolean
require_brand_profile_for_use
required
boolean
prompt
required
string
nullable
Example
I want an email design system with a header, a footer, and a content section.
ai_generation_status
required
string
nullable
Allowed values: generating done
Example
generating
archived
required
boolean
design_tokens
required
object
key
additional properties
any
Example
{
  "primary_button_color": "#007bff",
  "secondary_button_color": "#6c757d"
}
access_scope
required
string
Allowed values: all_workspaces this_workspace_only
Example
all_workspaces
custom_styles
required
Array<object>
object
style
required
string
Example
background-color: yellow; font-weight: bold;
name
required
string
Example
highlight
label
required
string
Example
Highlight

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

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