POST
/api/v2/users/{userId}/referrals/invitationsSends or resends an email-bound, expiring referral invitation.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| userId (path) | integer (int32) | Yes |
Request body
application/json
| Field | Type | Required | Description |
|---|---|---|---|
| RecipientEmail | string | Yes | |
| RecipientName | string | No |
Responses
201 — Created
| Field | Type | Required | Description |
|---|---|---|---|
| Id | string (uuid) | Yes | |
| RecipientEmail | string | Yes | |
| RecipientName | string | Yes | |
| RegisteredUserId | unknown | Yes | |
| Source | string | Yes | |
| Status | string | Yes | |
| DeliveryStatus | string | Yes | |
| SendCount | unknown | Yes | |
| CreatedAt | string (date-time) | Yes | |
| ExpiresAt | string (date-time) | Yes | |
| LastSentAt | string (date-time) | Yes | |
| AcceptedAt | string (date-time) | Yes |
Example request
curl -X POST "https://{base_url}/api/v2/users/{userId}/referrals/invitations" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"RecipientEmail":"…"}'This page is generated from the live OpenAPI specification and always matches the current API.