Skip to main content
API docs by Redocly

API V1 (v1)

Download OpenAPI specification:Download

Projects

List Projects

Retrieves the projects the user has access to.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

search
string

Filter projects by name

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Creates a project.

Creates a new project.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string

Project name

description
string or null

Project description

Responses

Request samples

Content type
application/json
{
  • "name": "Black Friday 2020",
  • "description": "All emails related to Black Friday 2020."
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "Black Friday 2023",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "description": "Black Friday 2023 Marketing Campaign",
  • "organization_id": 12345
}

Get Project

Retrieves a single project by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Project ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "Black Friday 2023",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "description": "Black Friday 2023 Marketing Campaign",
  • "organization_id": 12345
}

Update Project

Updates a project.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Project ID

Request Body schema: application/json
name
required
string

Project name

description
string or null

Project description

Responses

Request samples

Content type
application/json
{
  • "name": "Black Friday 2020",
  • "description": "All emails related to Black Friday 2020."
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "Black Friday 2023",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "description": "Black Friday 2023 Marketing Campaign",
  • "organization_id": 12345
}

Delete Project

Deletes a project.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Project ID

Responses

Project Users

List Project Users

Retrieves the users for a project.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Update Project Users

Updates the users for a project.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Project ID

Request Body schema: application/json
user_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "user_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Emails

List Emails

Retrieves the Emails the user has access to.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

project_id
integer

Filter emails by project ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create Email

Creates a new Email.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string
email_design_system_id
required
integer
default_locale
string (Locale)
Enum: "ar-SA" "bn-BD" "bn-IN" "cs-CZ" "da-DK" "de-AT" "de-CH" "de-DE" "el-GR" "en-AU" "en-CA" "en-GB" "en-IE" "en-IN" "en-NZ" "en-US" "en-ZA" "es-AR" "es-CL" "es-CO" "es-ES" "es-MX" "es-US" "fi-FI" "fr-BE" "fr-CA" "fr-CH" "fr-FR" "he-IL" "hi-IN" "hu-HU" "id-ID" "it-CH" "it-IT" "ja-JP" "ko-KR" "nl-BE" "nl-NL" "no-NO" "pl-PL" "pt-BR" "pt-PT" "ro-RO" "ru-RU" "sk-SK" "sv-SE" "ta-IN" "ta-LK" "th-TH" "tr-TR" "zh-CN" "zh-HK"
locales
Array of strings (Locale)
Items Enum: "ar-SA" "bn-BD" "bn-IN" "cs-CZ" "da-DK" "de-AT" "de-CH" "de-DE" "el-GR" "en-AU" "en-CA" "en-GB" "en-IE" "en-IN" "en-NZ" "en-US" "en-ZA" "es-AR" "es-CL" "es-CO" "es-ES" "es-MX" "es-US" "fi-FI" "fr-BE" "fr-CA" "fr-CH" "fr-FR" "he-IL" "hi-IN" "hu-HU" "id-ID" "it-CH" "it-IT" "ja-JP" "ko-KR" "nl-BE" "nl-NL" "no-NO" "pl-PL" "pt-BR" "pt-PT" "ro-RO" "ru-RU" "sk-SK" "sv-SE" "ta-IN" "ta-LK" "th-TH" "tr-TR" "zh-CN" "zh-HK"
project_id
required
integer
create_with_ai
boolean
ai_agent_id
integer
prompt
string
brand_profile_id
integer
link_tracking_profile_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email_design_system_id": 0,
  • "default_locale": "en-US",
  • "locales": [
    ],
  • "project_id": 0,
  • "create_with_ai": true,
  • "ai_agent_id": 0,
  • "prompt": "string",
  • "brand_profile_id": 0,
  • "link_tracking_profile_id": 0
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email",
  • "project_id": 12345,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "email_design_system_id": 12345,
  • "email_content": {
    },
  • "default_locale": "en-US",
  • "locales": [
    ],
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "last_updated_by": {},
  • "create_with_ai": false,
  • "prompt": "Write a welcome email to a new customer",
  • "ai_generation_status": "generating",
  • "ai_agent_id": 12345,
  • "brand_profile_id": 12345,
  • "link_tracking_profile_id": 12345
}

Get Email

Retrieves an email by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email",
  • "project_id": 12345,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "email_design_system_id": 12345,
  • "email_content": {
    },
  • "default_locale": "en-US",
  • "locales": [
    ],
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "last_updated_by": {},
  • "create_with_ai": false,
  • "prompt": "Write a welcome email to a new customer",
  • "ai_generation_status": "generating",
  • "ai_agent_id": 12345,
  • "brand_profile_id": 12345,
  • "link_tracking_profile_id": 12345
}

Update Email

Updates an email.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

Request Body schema: application/json
name
string
object (EmailContent)
default_locale
string (Locale)
Enum: "ar-SA" "bn-BD" "bn-IN" "cs-CZ" "da-DK" "de-AT" "de-CH" "de-DE" "el-GR" "en-AU" "en-CA" "en-GB" "en-IE" "en-IN" "en-NZ" "en-US" "en-ZA" "es-AR" "es-CL" "es-CO" "es-ES" "es-MX" "es-US" "fi-FI" "fr-BE" "fr-CA" "fr-CH" "fr-FR" "he-IL" "hi-IN" "hu-HU" "id-ID" "it-CH" "it-IT" "ja-JP" "ko-KR" "nl-BE" "nl-NL" "no-NO" "pl-PL" "pt-BR" "pt-PT" "ro-RO" "ru-RU" "sk-SK" "sv-SE" "ta-IN" "ta-LK" "th-TH" "tr-TR" "zh-CN" "zh-HK"
locales
Array of strings (Locale)
Items Enum: "ar-SA" "bn-BD" "bn-IN" "cs-CZ" "da-DK" "de-AT" "de-CH" "de-DE" "el-GR" "en-AU" "en-CA" "en-GB" "en-IE" "en-IN" "en-NZ" "en-US" "en-ZA" "es-AR" "es-CL" "es-CO" "es-ES" "es-MX" "es-US" "fi-FI" "fr-BE" "fr-CA" "fr-CH" "fr-FR" "he-IL" "hi-IN" "hu-HU" "id-ID" "it-CH" "it-IT" "ja-JP" "ko-KR" "nl-BE" "nl-NL" "no-NO" "pl-PL" "pt-BR" "pt-PT" "ro-RO" "ru-RU" "sk-SK" "sv-SE" "ta-IN" "ta-LK" "th-TH" "tr-TR" "zh-CN" "zh-HK"
link_tracking_profile_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email_content": {
    },
  • "default_locale": "en-US",
  • "locales": [
    ],
  • "link_tracking_profile_id": 0
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email",
  • "project_id": 12345,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "email_design_system_id": 12345,
  • "email_content": {
    },
  • "default_locale": "en-US",
  • "locales": [
    ],
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "last_updated_by": {},
  • "create_with_ai": false,
  • "prompt": "Write a welcome email to a new customer",
  • "ai_generation_status": "generating",
  • "ai_agent_id": 12345,
  • "brand_profile_id": 12345,
  • "link_tracking_profile_id": 12345
}

Delete Email

Deletes an email.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

Responses

Get Email Comments

Retrieves the email comments.

Authorizations:
CookieAuthBearerAuth
path Parameters
email_id
required
integer

Email ID

query Parameters
locale
required
string

Locale

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create Email Comment

Creates a new email comment.

Authorizations:
CookieAuthBearerAuth
path Parameters
email_id
required
integer

Email ID

Request Body schema: application/json
locale
required
string (Locale)
Enum: "ar-SA" "bn-BD" "bn-IN" "cs-CZ" "da-DK" "de-AT" "de-CH" "de-DE" "el-GR" "en-AU" "en-CA" "en-GB" "en-IE" "en-IN" "en-NZ" "en-US" "en-ZA" "es-AR" "es-CL" "es-CO" "es-ES" "es-MX" "es-US" "fi-FI" "fr-BE" "fr-CA" "fr-CH" "fr-FR" "he-IL" "hi-IN" "hu-HU" "id-ID" "it-CH" "it-IT" "ja-JP" "ko-KR" "nl-BE" "nl-NL" "no-NO" "pl-PL" "pt-BR" "pt-PT" "ro-RO" "ru-RU" "sk-SK" "sv-SE" "ta-IN" "ta-LK" "th-TH" "tr-TR" "zh-CN" "zh-HK"
parent_id
integer
body
required
string
object (PinData)

Responses

Request samples

Content type
application/json
{
  • "locale": "en-US",
  • "parent_id": 0,
  • "body": "string",
  • "pin_data": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "email_id": 12345,
  • "locale": "en-US",
  • "author": {},
  • "parent_id": 12345,
  • "pin_data": {
    },
  • "body": "This is a comment",
  • "created_at": "2023-08-23T10:30:00.000Z"
}

Update Email Comment

Updates an email comment.

Authorizations:
CookieAuthBearerAuth
path Parameters
email_id
required
integer

Email ID

email_comment_id
required
integer

Email Comment ID

Request Body schema: application/json
body
required
string

Responses

Request samples

Content type
application/json
{
  • "body": "string"
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "email_id": 12345,
  • "locale": "en-US",
  • "author": {},
  • "parent_id": 12345,
  • "pin_data": {
    },
  • "body": "This is a comment",
  • "created_at": "2023-08-23T10:30:00.000Z"
}

Delete Email Comment

Deletes an email comment.

Authorizations:
CookieAuthBearerAuth
path Parameters
email_id
required
integer

Email ID

email_comment_id
required
integer

Email Comment ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Create Email Translation

Creates a new Email Translation.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

Request Body schema: application/json
target_locales
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "target_locales": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "email_id": 12345,
  • "organization_id": 12345,
  • "target_locales": [
    ],
  • "status": "in_progress",
  • "locale_statuses": {
    }
}

Get Email Translation

Retrieves an email translation.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

email_translation_id
required
integer

Email Translation ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "email_id": 12345,
  • "organization_id": 12345,
  • "target_locales": [
    ],
  • "status": "in_progress",
  • "locale_statuses": {
    }
}

Get Email translation spreadsheet

Retrieves the content CSV for an email.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Upload Email Translation Spreadsheet

Uploads a CSV file to update an email translation.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

Request Body schema: multipart/form-data
csv_file
required
string <binary>

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email",
  • "project_id": 12345,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "email_design_system_id": 12345,
  • "email_content": {
    },
  • "default_locale": "en-US",
  • "locales": [
    ],
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "last_updated_by": {},
  • "create_with_ai": false,
  • "prompt": "Write a welcome email to a new customer",
  • "ai_generation_status": "generating",
  • "ai_agent_id": 12345,
  • "brand_profile_id": 12345,
  • "link_tracking_profile_id": 12345
}

Clone Email

Clones an email.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email ID

Request Body schema: application/json
name
required
string
clone_with_ai
boolean
prompt
string
ai_agent_id
integer

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "clone_with_ai": true,
  • "prompt": "string",
  • "ai_agent_id": 0
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email",
  • "project_id": 12345,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "email_design_system_id": 12345,
  • "email_content": {
    },
  • "default_locale": "en-US",
  • "locales": [
    ],
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "last_updated_by": {},
  • "create_with_ai": false,
  • "prompt": "Write a welcome email to a new customer",
  • "ai_generation_status": "generating",
  • "ai_agent_id": 12345,
  • "brand_profile_id": 12345,
  • "link_tracking_profile_id": 12345
}

Exports

List Exports

Retrieves the exports.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create Export

Creates a new export.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
connector_id
integer or null
email_id
required
integer
export_type
required
string
Enum: "html" "connector" "json" "pdf"
dynamic_content_profile_id
string or null
required
object (ExportOptions)

Responses

Request samples

Content type
application/json
{
  • "connector_id": 0,
  • "email_id": 0,
  • "export_type": "html",
  • "dynamic_content_profile_id": "string",
  • "options": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "organization_id": 12345,
  • "connector_id": 12345,
  • "email_id": 12345,
  • "email": {
    },
  • "dynamic_content_profile_id": "a8c5c5c0-5b1a-4b5a-9b0a-5e8b5c5c5c5c",
  • "status": "in_progress",
  • "export_type": "html",
  • "options": {
    },
  • "integration_name": "Brevo",
  • "metadata": {
    },
  • "export_errors": {
    },
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "download_zip_url": "https://www.example.com/download.zip",
  • "download_json_url": "https://www.example.com/download.json",
  • "open_in_integration_url": "https://www.example.com/integrations/mailchimp/export/12345"
}

Get Export

Retrieves an export.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Export ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "organization_id": 12345,
  • "connector_id": 12345,
  • "email_id": 12345,
  • "email": {
    },
  • "dynamic_content_profile_id": "a8c5c5c0-5b1a-4b5a-9b0a-5e8b5c5c5c5c",
  • "status": "in_progress",
  • "export_type": "html",
  • "options": {
    },
  • "integration_name": "Brevo",
  • "metadata": {
    },
  • "export_errors": {
    },
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "download_zip_url": "https://www.example.com/download.zip",
  • "download_json_url": "https://www.example.com/download.json",
  • "open_in_integration_url": "https://www.example.com/integrations/mailchimp/export/12345"
}

Email Design Systems

List Email Design Systems

Retrieves the email design systems for the currently logged in user.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

archived
string
Default: false
Enum: "true" "false" "all"
Example: archived=false

Filter projects by archive status:

  • false (default): Only return non-archived projects
  • true: Only return archived projects
  • all: Return both archived and non-archived projects

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create Email Design System

Creates a new email design system.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string
description
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email Design System",
  • "description": "My Email Design System",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "screenshot_url": "https://www.example.com/screenshot.png",
  • "upload_status": "success",
  • "create_with_ai": false,
  • "prompt": "I want an email design system with a header, a footer, and a content section.",
  • "ai_generation_status": "generating",
  • "archived": false
}

Get Email Design System

Retrieves an email design system.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email Design System ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email Design System",
  • "description": "My Email Design System",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "screenshot_url": "https://www.example.com/screenshot.png",
  • "upload_status": "success",
  • "create_with_ai": false,
  • "prompt": "I want an email design system with a header, a footer, and a content section.",
  • "ai_generation_status": "generating",
  • "archived": false
}

Update Email Design System

Updates an email design system.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email Design System ID

Request Body schema: application/json
name
string
description
string or null
archived
boolean or null

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "archived": true
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email Design System",
  • "description": "My Email Design System",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "screenshot_url": "https://www.example.com/screenshot.png",
  • "upload_status": "success",
  • "create_with_ai": false,
  • "prompt": "I want an email design system with a header, a footer, and a content section.",
  • "ai_generation_status": "generating",
  • "archived": false
}

Delete Email Design System

Deletes an email design system.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Email Design System ID

Responses

Clone Email Design System

Clones an email design system.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Clone of My Design System"
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Email Design System",
  • "description": "My Email Design System",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "screenshot_url": "https://www.example.com/screenshot.png",
  • "upload_status": "success",
  • "create_with_ai": false,
  • "prompt": "I want an email design system with a header, a footer, and a content section.",
  • "ai_generation_status": "generating",
  • "archived": false
}

Reorder Components

Reorders the components.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

Request Body schema: application/json
component_ids
required
Array of integers

Responses

Request samples

Content type
application/json
{
  • "component_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Components

List Components

Retrieves the components.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

query Parameters
brand_profile_id
integer
Default: null

Brand Profile ID

Responses

Response samples

Content type
application/json
{
  • "results": [
    ]
}

Create Component

Creates a new component.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

Request Body schema: application/json
name
required
string
label
required
string
template
required
string
required
Array of TextFieldDefinition (object) or NumberFieldDefinition (object) or EnumFieldDefinition (object) or BooleanFieldDefinition (object) or UrlFieldDefinition (object) or ImageFieldDefinition (object) or ColorFieldDefinition (object) or RichTextFieldDefinition (object) (FieldDefinition)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "template": "string",
  • "field_definitions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "MyComponent",
  • "label": "My Component",
  • "email_design_system_id": 12345,
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "container": false,
  • "template": "<div>My Component</div>",
  • "field_definitions": [
    ],
  • "screenshot_url": "https://www.example.com/screenshot.png",
  • "position": 1
}

Get Component

Retrieves a component.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Component ID

emailDesignSystemId
required
integer

Email Design System ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "MyComponent",
  • "label": "My Component",
  • "email_design_system_id": 12345,
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "container": false,
  • "template": "<div>My Component</div>",
  • "field_definitions": [
    ],
  • "screenshot_url": "https://www.example.com/screenshot.png",
  • "position": 1
}

Update Component

Updates a component.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Component ID

emailDesignSystemId
required
integer

Email Design System ID

Request Body schema: application/json
name
string
label
string
template
string
Array of TextFieldDefinition (object) or NumberFieldDefinition (object) or EnumFieldDefinition (object) or BooleanFieldDefinition (object) or UrlFieldDefinition (object) or ImageFieldDefinition (object) or ColorFieldDefinition (object) or RichTextFieldDefinition (object) (FieldDefinition)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "label": "string",
  • "template": "string",
  • "field_definitions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "MyComponent",
  • "label": "My Component",
  • "email_design_system_id": 12345,
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "container": false,
  • "template": "<div>My Component</div>",
  • "field_definitions": [
    ],
  • "screenshot_url": "https://www.example.com/screenshot.png",
  • "position": 1
}

Delete Component

Deletes a component.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Component ID

emailDesignSystemId
required
integer

Email Design System ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Brand Profiles

List Brand Profiles

Retrieves the brand profiles

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create Brand Profile

Creates a new brand profile.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

Request Body schema: application/json
name
required
string
required
Array of objects (BrandProfileComponentOverride)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "component_overrides": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "My Brand",
  • "component_overrides": [
    ],
  • "created_at": "2021-01-01T00:00:00Z",
  • "updated_at": "2021-01-01T00:00:00Z",
  • "email_design_system_id": 1
}

Get Brand Profile

Retrieves a brand profile.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

id
required
integer

Brand Profile ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "My Brand",
  • "component_overrides": [
    ],
  • "created_at": "2021-01-01T00:00:00Z",
  • "updated_at": "2021-01-01T00:00:00Z",
  • "email_design_system_id": 1
}

Update Brand Profile

Updates a brand profile.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

id
required
integer

Brand Profile ID

Request Body schema: application/json
name
string
Array of objects (BrandProfileComponentOverride)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "component_overrides": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "My Brand",
  • "component_overrides": [
    ],
  • "created_at": "2021-01-01T00:00:00Z",
  • "updated_at": "2021-01-01T00:00:00Z",
  • "email_design_system_id": 1
}

Delete Brand Profile

Deletes a brand profile.

Authorizations:
CookieAuthBearerAuth
path Parameters
emailDesignSystemId
required
integer

Email Design System ID

id
required
integer

Brand Profile ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Dynamic Content Profiles

List Dynamic Content Profiles

Retrieves the dynamic content profiles for the currently logged in user.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create Dynamic Content Profile

Creates a new DynamicContentProfile for the currently logged in user.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "Mailchimp Profile"
}

Response samples

Content type
application/json
{
  • "id": "uuid TODO",
  • "name": "Mailchimp Profile",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345
}

Get Dynamic Content Profile

Retrieves a DynamicContentProfile.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string

DynamicContentProfile ID

Responses

Response samples

Content type
application/json
{
  • "id": "uuid TODO",
  • "name": "Mailchimp Profile",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345
}

Update Dynamic Content Profile

Updates a DynamicContentProfile.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string

Conditional ID

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "Mailchimp Profile"
}

Response samples

Content type
application/json
{
  • "id": "uuid TODO",
  • "name": "Mailchimp Profile",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345
}

Delete Dynamic Content Profile

Deletes a DynamicContentProfile.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string

DynamicContentProfile ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Conditionals

List Conditionals

Retrieves the conditionals.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create Conditionals

Creates a new conditional.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
label
required
string
default_value
required
string
object (DynamicContentProfileValues)

Responses

Request samples

Content type
application/json
{
  • "label": "Over age 30",
  • "default_value": "TODO",
  • "dynamic_content_profile_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "label": "Over age 30s",
  • "default_syntax": {
    },
  • "branches": [
    ],
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "dynamic_content_profile_syntaxes": {
    }
}

Get Conditional

Retrieves a conditional.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Conditional ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "label": "Over age 30s",
  • "default_syntax": {
    },
  • "branches": [
    ],
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "dynamic_content_profile_syntaxes": {
    }
}

Update Conditional

Updates a conditional.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Conditional ID

Request Body schema: application/json
label
string
default_value
string
object (DynamicContentProfileValues)

Responses

Request samples

Content type
application/json
{
  • "label": "Over Age 30s",
  • "default_value": "TODO",
  • "dynamic_content_profile_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "label": "Over age 30s",
  • "default_syntax": {
    },
  • "branches": [
    ],
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "dynamic_content_profile_syntaxes": {
    }
}

Delete Conditional

Deletes a conditional.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Conditional ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

PersonalizationTags

List PersonalizationTags

Retrieves the personalization_tags.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create PersonalizationTag

Creates a new personalization_tag.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
label
required
string
default_value
required
string
example_value
required
string
object (DynamicContentProfileValues)

Responses

Request samples

Content type
application/json
{
  • "label": "First name",
  • "default_value": "{{firstName}}",
  • "example_value": "John",
  • "dynamic_content_profile_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "label": "First name",
  • "default_value": "{{firstName}}",
  • "example_value": "John",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "dynamic_content_profile_values": {
    }
}

Get PersonalizationTag

Retrieves a personalization_tag.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

PersonalizationTag ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "label": "First name",
  • "default_value": "{{firstName}}",
  • "example_value": "John",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "dynamic_content_profile_values": {
    }
}

Update PersonalizationTag

Updates a personalization_tag.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

PersonalizationTag ID

Request Body schema: application/json
label
string
default_value
string
example_value
string
object (DynamicContentProfileValues)

Responses

Request samples

Content type
application/json
{
  • "label": "First name",
  • "default_value": "{{firstName}}",
  • "example_value": "John",
  • "dynamic_content_profile_values": {
    }
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "label": "First name",
  • "default_value": "{{firstName}}",
  • "example_value": "John",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "dynamic_content_profile_values": {
    }
}

Delete PersonalizationTag

Deletes a personalization_tag.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

PersonalizationTag ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

LinkTrackingProfiles

List LinkTrackingProfiles

Retrieves the link_tracking_profiles.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create LinkTrackingProfile

Creates a new Link Tracking Profile.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string
Array of LinkTrackingProfileFixedValue (object) or LinkTrackingProfileEditorFieldValue (object) or LinkTrackingProfileEditorGlobalFieldValue (object) (LinkTrackingProfileParameter)
custom_template
required
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "My Link Tracking Profile",
  • "parameters": [
    ],
  • "custom_template": "{{ url }}"
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Link Tracking Profile",
  • "parameters": [
    ],
  • "custom_template": "{{ url }}",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Get LinkTrackingProfile

Retrieves a link_tracking_profile.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

LinkTrackingProfile ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Link Tracking Profile",
  • "parameters": [
    ],
  • "custom_template": "{{ url }}",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Update LinkTrackingProfile

Updates a link_tracking_profile.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

LinkTrackingProfile ID

Request Body schema: application/json
name
string
Array of LinkTrackingProfileFixedValue (object) or LinkTrackingProfileEditorFieldValue (object) or LinkTrackingProfileEditorGlobalFieldValue (object) (LinkTrackingProfileParameter)
custom_template
string or null

Responses

Request samples

Content type
application/json
{
  • "name": "My Link Tracking Profile",
  • "parameters": [
    ],
  • "custom_template": "{{ url }}"
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My Link Tracking Profile",
  • "parameters": [
    ],
  • "custom_template": "{{ url }}",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Delete LinkTrackingProfile

Deletes a link_tracking_profile.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

LinkTrackingProfile ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Images

List Images

Retrieves the images.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

search
string

Filter images by search term

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create Image

Creates a new image.

Authorizations:
CookieAuthBearerAuth
Request Body schema: multipart/form-data
file
required
string <binary>
name
string

Responses

Response samples

Content type
application/json
{
  • "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
  • "name": "My Image",
  • "filename": "image.png",
  • "width": 100,
  • "height": 100,
  • "file_size": 1000,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "public_url": "https://www.example.com/image.png",
  • "description": "A beautiful image of a cat",
  • "extension": "png"
}

Get Image

Retrieves an image.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string

Image ID

Responses

Response samples

Content type
application/json
{
  • "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
  • "name": "My Image",
  • "filename": "image.png",
  • "width": 100,
  • "height": 100,
  • "file_size": 1000,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "public_url": "https://www.example.com/image.png",
  • "description": "A beautiful image of a cat",
  • "extension": "png"
}

Update Image

Updates an image.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string

Image ID

Request Body schema: application/json
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "New Name"
}

Response samples

Content type
application/json
{
  • "id": "bd1c1b82-1a7b-4f0f-b079-30c1d4189bed",
  • "name": "My Image",
  • "filename": "image.png",
  • "width": 100,
  • "height": 100,
  • "file_size": 1000,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "public_url": "https://www.example.com/image.png",
  • "description": "A beautiful image of a cat",
  • "extension": "png"
}

Delete Image

Deletes an image.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
string

Image ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Users

List users

Retrieves the users.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

search
string

Filter users by search term

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create user

Creates a new user.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
first_name
required
string
last_name
required
string
email
required
string
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "first_name": "Joe",
  • "last_name": "Cottam",
  • "email": "[email protected]",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "role_id": 12345,
  • "invitation_sent_at": "2023-08-23T10:30:00.000Z",
  • "invitation_accepted_at": "2023-08-23T10:30:00.000Z",
  • "permissions": [
    ],
  • "profile_image_url": "https://example.com/profile.jpg",
  • "wants_marketing_emails": false
}

Get user

Retrieves a user.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

User ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "first_name": "Joe",
  • "last_name": "Cottam",
  • "email": "[email protected]",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "role_id": 12345,
  • "invitation_sent_at": "2023-08-23T10:30:00.000Z",
  • "invitation_accepted_at": "2023-08-23T10:30:00.000Z",
  • "permissions": [
    ],
  • "profile_image_url": "https://example.com/profile.jpg",
  • "wants_marketing_emails": false
}

Update user

Updates a user.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

User ID

Request Body schema: application/json
role_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "role_id": 0
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "first_name": "Joe",
  • "last_name": "Cottam",
  • "email": "[email protected]",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z",
  • "organization_id": 12345,
  • "role_id": 12345,
  • "invitation_sent_at": "2023-08-23T10:30:00.000Z",
  • "invitation_accepted_at": "2023-08-23T10:30:00.000Z",
  • "permissions": [
    ],
  • "profile_image_url": "https://example.com/profile.jpg",
  • "wants_marketing_emails": false
}

Delete user

Deletes a user.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

User ID

Responses

Response samples

Content type
application/json
{
  • "errors": {
    }
}

Connectors

List connectors

Retrieves connectors.

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{}

Creates a connector.

Creates a new connector.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string

Connector name

integration_name
required
string

Integration name

required
object

Responses

Request samples

Content type
application/json
{
  • "name": "Mailchimp",
  • "integration_name": "mailchimp",
  • "settings": { }
}

Response samples

Content type
application/json
{}

Get connector

Retrieves a single connector by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Connector ID

Responses

Response samples

Content type
application/json
{}

Update connector

Updates a connector.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Project ID

Request Body schema: application/json
name
string

Connector name

integration_name
string

Integration name

object

Responses

Request samples

Content type
application/json
{
  • "name": "Mailchimp",
  • "integration_name": "mailchimp",
  • "settings": { }
}

Response samples

Content type
application/json
{}

Delete connector

Deletes a connector.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Connector ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

AIAgents

List AI agents

Retrieves the AI agents

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create AI agent

Creates a new AI agent.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string
company_name
string
company_overview
string
tone
string
guidelines
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_name": "string",
  • "company_overview": "string",
  • "tone": "string",
  • "guidelines": "string"
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My AI Agent",
  • "company_name": "My Company",
  • "company_overview": "My Company is a company that makes widgets.",
  • "tone": "My Company is a company that makes widgets.",
  • "guidelines": "My Company is a company that makes widgets.",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Get AI agent

Retrieves a single AI agent by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

AI agent ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My AI Agent",
  • "company_name": "My Company",
  • "company_overview": "My Company is a company that makes widgets.",
  • "tone": "My Company is a company that makes widgets.",
  • "guidelines": "My Company is a company that makes widgets.",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Update AI agent

Updates a single AI agent by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

AI agent ID

Request Body schema: application/json
name
string
company_name
string
company_overview
string
tone
string
guidelines
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "company_name": "string",
  • "company_overview": "string",
  • "tone": "string",
  • "guidelines": "string"
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My AI Agent",
  • "company_name": "My Company",
  • "company_overview": "My Company is a company that makes widgets.",
  • "tone": "My Company is a company that makes widgets.",
  • "guidelines": "My Company is a company that makes widgets.",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Delete AI agent

Deletes a single AI agent by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

AI agent ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}

Renders

Render

Renders the selected components of an email design system

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
email_design_system_id
required
integer

ID of the email design system

brand_profile_id
integer

ID of the brand profile

required
object

Responses

Request samples

Content type
application/json
{
  • "email_design_system_id": 0,
  • "brand_profile_id": 0,
  • "content": {
    }
}

Response samples

Content type
application/json
{
  • "html": "string",
  • "created_at": "2023-08-23T10:30:00.000Z"
}

Roles

List roles

Retrieves the roles

Authorizations:
CookieAuthBearerAuth
query Parameters
per
integer
Default: 10

Number of records per page

page
integer
Default: 1

Page number

Responses

Response samples

Content type
application/json
{
  • "results": [
    ],
  • "pagination": {
    }
}

Create role

Creates a new role.

Authorizations:
CookieAuthBearerAuth
Request Body schema: application/json
name
required
string
role_permissions
required
Array of strings (PermissionKey)
Items Enum: "update_emails" "add_remove_reorder_email_components" "add_remove_conditional_from_components" "add_remove_locales_from_emails" "create_emails" "delete_emails" "update_library_images" "create_library_images" "delete_library_images" "access_all_projects" "update_projects" "create_projects" "delete_projects" "update_email_design_systems" "create_email_design_systems" "delete_email_design_systems" "update_dynamic_content_profiles" "create_dynamic_content_profiles" "delete_dynamic_content_profiles" "update_personalization_tags" "create_personalization_tags" "delete_personalization_tags" "update_conditionals" "create_conditionals" "delete_conditionals" "update_link_tracking_profiles" "create_link_tracking_profiles" "delete_link_tracking_profiles" "create_connectors" "update_connectors" "delete_connectors" "create_exports" "update_organization" "manage_billing" "manage_api_keys" "manage_organization_sso_settings" "view_audit_logs" "send_test_emails" "update_users" "create_users" "delete_users" "update_ai_agents" "create_ai_agents" "delete_ai_agents" "create_roles" "update_roles" "delete_roles" "create_brand_profiles" "update_brand_profiles" "delete_brand_profiles" "email_commenting"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "Admin",
  • "role_permissions": [
    ],
  • "builtin": false,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Get role

Retrieves a single role by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Role ID

Responses

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "Admin",
  • "role_permissions": [
    ],
  • "builtin": false,
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Update role

Updates a single role by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Role ID

Request Body schema: application/json
name
string
role_permissions
Array of strings (PermissionKey)
Items Enum: "update_emails" "add_remove_reorder_email_components" "add_remove_conditional_from_components" "add_remove_locales_from_emails" "create_emails" "delete_emails" "update_library_images" "create_library_images" "delete_library_images" "access_all_projects" "update_projects" "create_projects" "delete_projects" "update_email_design_systems" "create_email_design_systems" "delete_email_design_systems" "update_dynamic_content_profiles" "create_dynamic_content_profiles" "delete_dynamic_content_profiles" "update_personalization_tags" "create_personalization_tags" "delete_personalization_tags" "update_conditionals" "create_conditionals" "delete_conditionals" "update_link_tracking_profiles" "create_link_tracking_profiles" "delete_link_tracking_profiles" "create_connectors" "update_connectors" "delete_connectors" "create_exports" "update_organization" "manage_billing" "manage_api_keys" "manage_organization_sso_settings" "view_audit_logs" "send_test_emails" "update_users" "create_users" "delete_users" "update_ai_agents" "create_ai_agents" "delete_ai_agents" "create_roles" "update_roles" "delete_roles" "create_brand_profiles" "update_brand_profiles" "delete_brand_profiles" "email_commenting"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "role_permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 12345,
  • "name": "My AI Agent",
  • "company_name": "My Company",
  • "company_overview": "My Company is a company that makes widgets.",
  • "tone": "My Company is a company that makes widgets.",
  • "guidelines": "My Company is a company that makes widgets.",
  • "created_at": "2023-08-23T10:30:00.000Z",
  • "updated_at": "2023-08-23T10:30:00.000Z"
}

Delete role

Deletes a single role by ID.

Authorizations:
CookieAuthBearerAuth
path Parameters
id
required
integer

Role ID

Responses

Response samples

Content type
application/json
{
  • "message": "Record not found"
}