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 preview. The complete command JSON is limited to 256 KiB; decoded files are limited to 64 KiB and 1,000 data rows.

file_base64
string
required

Standard base64 encoding of a CSV or XLSX file, up to 64 KiB decoded.

Required string length: 1 - 87384
filename
string
required
Required string length: 1 - 255
mapping
object
required
channel
enum<string>
required
Available options:
email,
linkedin
offset
integer
default:0
Required range: x >= 0
limit
integer
default:25
Required range: 1 <= x <= 100

Response

Success

data
object
required