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
channel
enum<string>
required

Resource identifier.

Available options:
email,
linkedin
campaign_id
integer
required

Resource identifier.

Required range: x >= 1

Body

application/json
expected_revision
string
required
Pattern: ^[a-f0-9]{64}$
name
string
Required string length: 1 - 255
sender_ids
integer[]
Maximum array length: 100
Required range: x >= 1
reply_owner_subclient_id
integer | null
Required range: x >= 1
reply_routing
enum<string>
Available options:
person,
sender
language
string
Required string length: 1 - 50
audience
string | null
Maximum string length: 10000
sender_context
string | null
Maximum string length: 10000
schedule
object
steps
object

Response

Success

data
object
required