Overview

API V1 (v1)

• OpenAPI version: 3.0.1

Authentication

BearerAuth

Bearer token authentication

Security scheme type: http

Bearer format: JWT

OAuth2

OAuth 2.1 authorization for OAuth and MCP apps. Scopes cap what an app may do on the authorizing user’s behalf. The effective authority of a token is the intersection of the user’s role permissions, their workspace/team membership, and the scopes granted here.

Security scheme type: oauth2

Flow type: authorizationCode

Authorization URL: /oauth/authorize

Token URL: /oauth/token

Scopes:

• identity - Read your basic account info
• projects:read - Read projects
• projects:write - Create and update projects
• projects:delete - Delete projects
• emails:read - Read emails
• emails:write - Create and update emails
• emails:delete - Delete emails
• emails:publish - Publish emails
• emails:convert_to_draft - Convert emails back to draft
• emails:ai_edit - Edit emails with AI
• comments:read - Read email comments
• comments:write - Create and update email comments
• comments:delete - Delete email comments
• reviews:read - Read approval workflows
• reviews:write - Submit emails for review and approve or reject them
• ai_reviews:read - Read AI reviews
• ai_reviews:write - Trigger AI reviews
• rendered_assets:create - Create and read rendered email assets
• email_design_systems:read - Read email design systems, brand profiles, and components
• email_design_systems:write - Create and update email design systems, brand profiles, and components
• email_design_systems:delete - Delete email design systems, brand profiles, and components
• personalization_tags:read - Read personalization tags
• personalization_tags:write - Create and update personalization tags
• personalization_tags:delete - Delete personalization tags
• link_tracking_profiles:read - Read link tracking profiles
• link_tracking_profiles:write - Create and update link tracking profiles
• link_tracking_profiles:delete - Delete link tracking profiles
• conditionals:read - Read conditionals
• conditionals:write - Create and update conditionals
• conditionals:delete - Delete conditionals
• dynamic_content_profiles:read - Read dynamic content profiles
• dynamic_content_profiles:write - Create and update dynamic content profiles
• dynamic_content_profiles:delete - Delete dynamic content profiles
• feeds:read - Read feeds
• feeds:write - Create, update, and run feeds
• feeds:delete - Delete feeds
• agents:read - Read AI agents and reviewers
• agents:write - Create and update AI agents and reviewers
• agents:delete - Delete AI agents and reviewers
• exports:read - Read exports
• exports:write - Create exports
• connectors:read - Read connectors
• connectors:write - Create and update connectors
• connectors:delete - Delete connectors
• roles:read - Read roles
• roles:write - Create and update roles
• roles:delete - Delete roles
• users:read - Read users
• users:write - Create and update users
• users:delete - Delete users
• workspaces:read - Read workspaces and their members
• workspaces:write - Create and update workspaces, and manage workspace membership
• workspaces:delete - Delete workspaces
• teams:read - Read teams and their members
• teams:write - Create and update teams, and manage team membership
• teams:delete - Delete teams
• review_groups:read - Read review groups
• review_groups:write - Create and update review groups
• review_groups:delete - Delete review groups
• image_library:read - Read library images
• image_library:write - Upload and update library images
• image_library:delete - Delete library images
• layouts:read - Read layouts
• layouts:write - Create and update layouts
• layouts:delete - Delete layouts
• component_presets:read - Read component presets
• component_presets:write - Create and update component presets
• component_presets:delete - Delete component presets
• test_list:read - Read test lists
• test_list:write - Create and update test lists
• test_list:delete - Delete test lists
• test_emails:send - Send test emails
• renders:create - Render email design system components