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

Body

application/json

Supplied groups replace their stored lists; other groups and runtime keys are kept.

roles
string[]
Maximum array length: 200
Maximum string length: 200
companies
string[]
Maximum array length: 200
Maximum string length: 200
industries
string[]
Maximum array length: 200
Maximum string length: 200
keywords
string[]
Maximum array length: 200
Maximum string length: 200

Response

Success

data
object
required