Schemas-Emails

ScheduleDto

name
string
required
Example:
Untitled new campaign
repeatAfter
string
required
id
string
required
parentId
string
required
childCount
number
required
campaignType
string
required
bulkActionVersion
string
required
_id
string
required
status
string
required
sendDays
array[string]
required
deleted
boolean
required
migrated
boolean
required
archived
boolean
required
hasTracking
boolean
required
isPlainText
boolean
required
hasUtmTracking
boolean
required
enableResendToUnopened
boolean
required
locationId
string
required
templateId
string
required
templateType
string
required
createdAt
string
required
updatedAt
string
required
__v
number
required
documentId
string
required
downloadUrl
string
required
templateDataDownloadUrl
string
required
child
array[string]
required
Example 
{
  "name": "Untitled new campaign",
  "repeatAfter": "string",
  "id": "string",
  "parentId": "string",
  "childCount": 0,
  "campaignType": "string",
  "bulkActionVersion": "string",
  "_id": "string",
  "status": "string",
  "sendDays": [
    "string"
  ],
  "deleted": true,
  "migrated": true,
  "archived": true,
  "hasTracking": true,
  "isPlainText": true,
  "hasUtmTracking": true,
  "enableResendToUnopened": true,
  "locationId": "string",
  "templateId": "string",
  "templateType": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "__v": 0,
  "documentId": "string",
  "downloadUrl": "string",
  "templateDataDownloadUrl": "string",
  "child": [
    "string"
  ]
}

ScheduleFetchSuccessfulDTO

schedules
array[object]
required

The list of campaigns

name
string
required
Example:
Untitled new campaign
repeatAfter
string
required
id
string
required
parentId
string
required
childCount
number
required
campaignType
string
required
bulkActionVersion
string
required
_id
string
required
status
string
required
sendDays
array[string]
required
deleted
boolean
required
migrated
boolean
required
archived
boolean
required
hasTracking
boolean
required
isPlainText
boolean
required
hasUtmTracking
boolean
required
enableResendToUnopened
boolean
required
locationId
string
required
templateId
string
required
templateType
string
required
createdAt
string
required
updatedAt
string
required
__v
number
required
documentId
string
required
downloadUrl
string
required
templateDataDownloadUrl
string
required
child
array[string]
required
total
array[string]
required

The total number of campaigns

traceId
string
required

Trace Id

Example 
{
  "schedules": [
    {
      "name": "Untitled new campaign",
      "repeatAfter": "string",
      "id": "string",
      "parentId": "string",
      "childCount": 0,
      "campaignType": "string",
      "bulkActionVersion": "string",
      "_id": "string",
      "status": "string",
      "sendDays": [
        null
      ],
      "deleted": true,
      "migrated": true,
      "archived": true,
      "hasTracking": true,
      "isPlainText": true,
      "hasUtmTracking": true,
      "enableResendToUnopened": true,
      "locationId": "string",
      "templateId": "string",
      "templateType": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "__v": 0,
      "documentId": "string",
      "downloadUrl": "string",
      "templateDataDownloadUrl": "string",
      "child": [
        null
      ]
    }
  ],
  "total": [
    "string"
  ],
  "traceId": "string"
}

BadRequestDTO

statusCode
number
Example:
400
message
string
Example:
Bad Request
Example 
{
  "statusCode": 400,
  "message": "Bad Request"
}

UnauthorizedDTO

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
Example 
{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

InvalidLocationDTO

statusCode
number
Example:
403
message
string
Example:
The token does not have access to this location
Example 
{
  "statusCode": 403,
  "message": "The token does not have access to this location"
}

NotFoundDTO

statusCode
number
Example:
404
message
string
Example:
Not Found
error
string
Example:
The requested resource was not found
Example 
{
  "statusCode": 404,
  "message": "Not Found",
  "error": "The requested resource was not found"
}

UnprocessableDTO

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
Example 
{
  "statusCode": 422,
  "message": [
    "Unprocessable Entity"
  ],
  "error": "Unprocessable Entity"
}

CreateBuilderDto

locationId
string
required
Example:
ve9EPM428h8vShlRW1KT
title
string
Example:
template title
type
string
required
Allowed values:
htmlfolderimportbuilderblank
updatedBy
string
Example:
zYy3YOUuHxgomU1uYJty
builderVersion
string
Allowed values:
12
Default:
2
name
string
Example:
Template1
parentId
string
Example:
zYy3YOUuHxgomU1uYJty
templateDataUrl
string
Example:
importProvider
string
required
Allowed values:
mailchimpactive_campaignkajabi
importURL
string
Example:
https://tplshare.com/fhYJ3Mi
templateSource
string
Example:
template_library
isPlainText
boolean
Example:
false
Example 
{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "title": "template title",
  "type": "html",
  "updatedBy": "zYy3YOUuHxgomU1uYJty",
  "builderVersion": "2",
  "name": "Template1",
  "parentId": "zYy3YOUuHxgomU1uYJty",
  "templateDataUrl": "",
  "importProvider": "mailchimp",
  "importURL": "https://tplshare.com/fhYJ3Mi",
  "templateSource": "template_library",
  "isPlainText": false
}

CreateBuilderSuccesfulResponseDto

redirect
string
required

template id

Example:
66e811229245fc098765590
traceId
string
required

trace id

Example:
0c52e980-41f6-4be7-8c4b-e2c5a13dc3c2
Example 
{
  "redirect": "66e811229245fc098765590",
  "traceId": "0c52e980-41f6-4be7-8c4b-e2c5a13dc3c2"
}

FetchBuilderSuccesfulResponseDto

name
string

template name

Example:
New Template
updatedBy
string

updated by

Example:
John Doe
isPlainText
boolean

plain text based template

Example:
false
lastUpdated
string

last updated

Example:
2024-11-12T12:34:36.070Z
dateAdded
string

date added

Example:
2024-11-12T12:34:36.070Z
previewUrl
string

preview url

Example:
https://example.com
id
string

id

Example:
67334b231f2fad724062f52b5
version
string

version

Example:
1
templateType
string

type

Example:
builder
Example 
{
  "name": "New Template",
  "updatedBy": "John Doe",
  "isPlainText": "false",
  "lastUpdated": "2024-11-12T12:34:36.070Z",
  "dateAdded": "2024-11-12T12:34:36.070Z",
  "previewUrl": "https://example.com",
  "id": "67334b231f2fad724062f52b5",
  "version": "1",
  "templateType": "builder"
}

DeleteBuilderSuccesfulResponseDto

ok
string

ok

Example:
true
traceId
string

trace id

Example:
0c52e980-41f6-4be7-8c4b-32332ss
Example 
{
  "ok": "true",
  "traceId": "0c52e980-41f6-4be7-8c4b-32332ss"
}

IBuilderJsonMapper

elements
array[string]
required
attrs
object
required
templateSettings
object
required
Example 
{
  "elements": [
    "string"
  ],
  "attrs": {},
  "templateSettings": {}
}

SaveBuilderDataDto

locationId
string
required
Example:
ve9EPM428h8vShlRW1KT
templateId
string
required
Example:
zYy3YOUuHxgomU1uYJty
updatedBy
string
required
Example:
zYy3YOUuHxgomU1uYJty
dnd
object
required
Example:
{elements:[], attrs:{}, templateSettings:{}}
elements
array[string]
required
attrs
object
required
templateSettings
object
required
html
string
required
Example:
editorType
string
required
Allowed values:
htmlbuilder
previewText
string
Example:
zYy3YOUuHxgomU1uYJty
isPlainText
boolean
Example:
false
Example 
{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "templateId": "zYy3YOUuHxgomU1uYJty",
  "updatedBy": "zYy3YOUuHxgomU1uYJty",
  "dnd": {
    "0": "{",
    "1": "e",
    "2": "l",
    "3": "e",
    "4": "m",
    "5": "e",
    "6": "n",
    "7": "t",
    "8": "s",
    "9": ":",
    "10": "[",
    "11": "]",
    "12": ",",
    "13": " ",
    "14": "a",
    "15": "t",
    "16": "t",
    "17": "r",
    "18": "s",
    "19": ":",
    "20": "{",
    "21": "}",
    "22": ",",
    "23": " ",
    "24": "t",
    "25": "e",
    "26": "m",
    "27": "p",
    "28": "l",
    "29": "a",
    "30": "t",
    "31": "e",
    "32": "S",
    "33": "e",
    "34": "t",
    "35": "t",
    "36": "i",
    "37": "n",
    "38": "g",
    "39": "s",
    "40": ":",
    "41": "{",
    "42": "}",
    "43": "}",
    "elements": [
      "string"
    ],
    "attrs": {},
    "templateSettings": {}
  },
  "html": "",
  "editorType": "html",
  "previewText": "zYy3YOUuHxgomU1uYJty",
  "isPlainText": "false"
}

BuilderUpdateSuccessfulDTO

ok
string

ok

Example:
true
traceId
string

trace id

Example:
0c52e980-41f6-4be7-8c4b-32332ss
previewUrl
string

preview url

Example:
https://example.com
templateDownloadUrl
string

template data download url

Example:
https://example.com
Example 
{
  "ok": "true",
  "traceId": "0c52e980-41f6-4be7-8c4b-32332ss",
  "previewUrl": "https://example.com",
  "templateDownloadUrl": "https://example.com"
}