CreateEmailV2Request¶
Type: object
Request body for creating an email. appData must include at least one of: folderId, workspaceId, or programId.
Properties¶
| Property | Type | Required | Description | Constraints |
|---|---|---|---|---|
name |
string | Yes | ||
description |
string | No | ||
appData |
model: EmailAppDataDTO | Yes | ||
data |
model: DataDTO | No | ||
headers |
model: EmailHeadersDTO | Yes | ||
editorContext |
model: EditorContextDto | No | ||
settings |
model: EmailSettingsDTO | No | ||
templateId |
string | No | When provided, the template's content overwrites any data sent in the request. |
Generated example¶
{
"name": "Example name",
"description": "string",
"appData": {
"editorType": "string",
"folderId": "123",
"programId": "123",
"workspaceId": "123"
},
"data": {
"html": {
"body": "string"
},
"text": {
"body": "string",
"syncFromHtml": true
}
},
"headers": {
"ccEmails": [
"person@example.com"
],
"fromEmail": "person@example.com",
"fromName": "Example name",
"preheader": "string",
"replyEmail": "person@example.com",
"subject": "string"
},
"editorContext": {
"dynamicContent": {}
},
"settings": {
"brandedDomain": "string",
"dedicatedIp": "string",
"enableUrlTracking": true,
"isOperational": true,
"isTextOnly": true,
"isWebPageView": true
},
"templateId": "123"
}
Referenced models¶
Source¶
Generated from swagger-asset.json.