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

Read-only selection preview. Provide exactly one of contact_ids or filters; no contact is changed.

contact_ids
integer[]
required
Required array length: 1 - 5000 elements
Required range: x >= 1
channel
enum<string>
default:email
Available options:
email,
linkedin
filters
object

Response

Success

data
object
required