Skip to main content
POST
cURL
Read the recovery rules before retrying a write. Keep the same key and body for the same logical operation.

Authorizations

Authorization
string
header
required

ex_test_ or ex_live_ key issued by an Emailx operator. Never use provider keys or session cookies.

Headers

Idempotency-Key
string
required

Unique per logical mutation. Same path and body replay for 24 hours.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_.:/-]+$

Path Parameters

workspace_id
integer
required

Emailx workspace (Clients) ID, not the agency workspace link ID.

Required range: x >= 1

Body

application/json
name
string
required
Required string length: 1 - 120
subject
string | null
Maximum string length: 500
preview_text
string | null
Maximum string length: 5000
body
string | null
Maximum string length: 5000
prompt
string | null
Maximum string length: 5000
prompt_html
string | null
Maximum string length: 5000
subject_instruction
string | null
Maximum string length: 5000
preview_instruction
string | null
Maximum string length: 5000
goal
string | null
default:Sales
Maximum string length: 50
language
string
default:English
Maximum string length: 50
ai_sections
object[] | null

IDs and positions must each be unique; input order is preserved.

Maximum array length: 100
unsubscribe
boolean
default:false
tracking
boolean
default:true
click_tracking
boolean
default:false
plain_text
boolean
default:false
include_signature
boolean
default:true

Response

Created

data
object
required