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
campaign_id
integer
required

Resource identifier.

Required range: x >= 1

Body

application/json

Inline rows up to 2,000 per request. Matching queued leads in the affected campaigns are skipped; contacted leads keep their history.

name
string
required
Required string length: 1 - 255
rows
object[]
required
Required array length: 1 - 2000 elements
scope
enum<string>
default:campaign
Available options:
campaign,
workspace
mode
enum<string>
default:both
Available options:
people,
companies,
both

Response

Created

data
object
required