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

Owner or admin only. Sends one invitation email through a durable operation; viewer is for agency client workspaces.

email
string<email>
required
Maximum string length: 254
role
enum<string>
default:member
Available options:
member,
admin,
viewer
message
string
Maximum string length: 1000

Response

Accepted

data
object
required