Skip to main content
POST
Send Invites

Send Invites

Send invite emails to all campaign recipients who have not been invited yet (last_invited_at is null). The endpoint is idempotent — calling it again after all recipients have been invited returns sent: 0.
To re-send an invite to a specific recipient, use Resend Invite instead.

Request

Headers

string
required
Your API key for authenticationExample: sk_live_1234567890abcdef
string
required
Your organization UUIDExample: a8315ef3-dd50-43f8-b7ce-d839e68d51fa

Path Parameters

string
required
UUID of the parent dataset
string
required
UUID of the campaign

Response

integer
Number of invite events dispatched on this call

Example

Successful Response

Common Errors

401 Unauthorized

Cause: Missing or invalid API key

403 Forbidden

Cause: The authenticated user is not a member of the organization

404 Not Found

Cause: Campaign not found

Create Campaign

Create a campaign first

Resend Invite

Re-send to a specific recipient