Skip to main content
PATCH
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
campaign_id
integer
required

Resource identifier.

Required range: x >= 1
task_id
integer
required

Resource identifier.

Required range: x >= 1

Body

application/json

Edits only the selected current preview. Read the message again after editing or a stale-revision conflict.

preview_id
integer
required
Required range: x >= 1
expected_revision
string
required
Pattern: ^[a-f0-9]{64}$
subject
string
Maximum string length: 500
body_html
string
Maximum string length: 5000
preheader
string
Maximum string length: 5000

Response

Success

data
object
required