Import an email template

POST 
/emails/locations/:locationId/templates/import

Import a template from a provider URL

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location ID

application/json

application/json

Body

Bodyrequired

importProviderstringrequired
Import provider (URL-based providers only)
Available optionsmailchimpactive_campaign
importUrlstringrequired

Public import URL

namestring

Template name

parentFolderIdstring

Parent folder ID

userIdstring

ID of the user performing this action

Example (auto)

{
  "importProvider": "mailchimp",
  "importUrl": "https://templates.example.com/public/template-123",
  "name": "Imported Template",
  "parentFolderId": "67f15c2ae99226d5bcccb8f0",
  "userId": "507f1f77bcf86cd799439011"
}

application/json

Success

application/json

Schema

Schema

idstringrequired

Template ID

namestringrequired

Template name

editorTypestringrequired
Editor type
Available optionshtmltext
isPlainTextbooleanrequired

Whether template is plain text

parentFolderIdstring

Parent folder ID

fromNamestring

Sender name

fromEmailstring

Sender email address

subjectLinestring

Email subject line

previewTextstring

Preview text

previewUrlstring

Preview URL

createdAtstring

Created timestamp

updatedAtstring

Updated timestamp

traceIdstring

Trace ID of request

Example (auto)

{
  "id": "507f1f77bcf86cd799439011",
  "name": "Newsletter Template",
  "editorType": "html",
  "isPlainText": false,
  "parentFolderId": "67f15c2ae99226d5bcccb8f0",
  "fromName": "John Doe",
  "fromEmail": "[email protected]",
  "subjectLine": "Welcome to our newsletter",
  "previewText": "Email preview text",
  "previewUrl": "https://example.com/preview/template123",
  "createdAt": "2025-07-24T11:55:43.598Z",
  "updatedAt": "2025-07-24T11:55:43.598Z",
  "traceId": "019e4ef5-a65e-4198-8cf9-8e93dca9bda4"
}