Send Invitation
Send or resend a signing invitation email to a recipient. You can target a specific recipient by ID or email, or let the API automatically select the next pending recipient.
Endpoint
POST https://api.airsign.com.au/api/v1/Session/{sessionId}/SendInvitation
Headers
| Name | Value | Required | Description |
|---|
| Content-Type | application/json | Yes | Specifies the format of the request body |
| Authorization | Bearer {access_token} | Yes | Bearer token obtained from authentication |
Path Parameters
| Parameter | Type | Required | Description |
|---|
| sessionId | string | Yes | The unique identifier of the session |
Request Body
All fields are optional. If none are provided, the invitation is sent to the next pending recipient.
| Parameter | Type | Required | Description |
|---|
| recipientId | string | No | Target a specific recipient by their ID |
| recipientEmail | string | No | Target a specific recipient by their email address |
Example Request
curl --location 'https://api.airsign.com.au/api/v1/Session/{sessionId}/SendInvitation' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access_token}' \
--data-raw '{
"recipientEmail": "[email protected]"
}'
Response
Status: 200 OK
{
"success": true,
"sessionId": "{uuid}",
"recipientId": "{uuid}",
"recipientEmail": "[email protected]",
"sentAt": "2025-06-15T10:30:00.000Z"
}
Error Responses
| Status | Description |
|---|
| 400 | Session is not in pending or inProgress status |
| 401 | Unauthorized - invalid or missing token |
| 404 | Session or recipient not found |
| 429 | Rate limit exceeded |