Skip to main content
POST
Apply email import

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.

Path Parameters

email_import_id
string
required

Public import ID.

Pattern: ^eim_[A-Za-z0-9_-]+$

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