Skip to main content
POST
Import HTML email

Authorizations

Authorization
string
header
required

API key created in the organization settings.

Headers

Idempotency-Key
string

Unique key for the operation. Repeating the same key with the same body returns the original response instead of running it again.

Body

application/json
html
string
required
Required string length: 1 - 8388608
language
enum<string>
required
Available options:
pt-BR,
en,
es
name
string
Maximum string length: 191
email_template_id
string

Imports into this template instead of creating a new one.

Pattern: ^etp_[A-Za-z0-9_-]+$
operation_id
string

Optional unique id for this call, such as a UUID. Reuse the same value only to retry the same call: the retry returns the first result instead of creating again. The same value with a different body is rejected with 409.

Required string length: 8 - 128

Response

Import state.

object
string
required
Allowed value: "email_import"
id
string
required
Pattern: ^eim_[A-Za-z0-9_-]+$
email_template_id
string | null
required
Pattern: ^etp_[A-Za-z0-9_-]+$
state
enum<string>
required
Available options:
running,
completed,
failed,
applied,
dismissed
quality
enum<string>

Completed imports: how faithful the editable copy is to the original.

Available options:
editable,
review,
fallback
title
string | null