POST /api/v3/invitations — Send Invitation V3
Version 3 of the Send Invitation API. This endpoint sends notifications to recipients via email or SMS and also returns the signing link directly in the API response, allowing clients to both rely on built-in notifications and handle additional communication through their own channels if needed.
Authentication
SadqAuthorize
Request Headers
- Authorization (required)
- Bearer {token}
- Content-Type (required)
- application/json
Request Body
Content-Type: application/json
- documentId (string, required)
- The ID of the document to be signed
- destinations (array, required)
- Array of destination objects (same as Send Invitation V1 ).
- invitationMessage (string, optional)
- Custom message for recipients.
- invitationSubject (string, optional)
- Subject of the invitation email.
{
"documentId": "",
"destinations": [
{
"destinationName": "",
"destinationEmail": "",
"destinationPhoneNumber": "",
"signeOrder": 0,
"ConsentOnly": true,
"destinationType": 1,
"signatories": [],
"availableTo": "",
"allowUserToSignAnyWhere": false,
"authenticationType": 3,
"invitationLanguage": 1,
"redirectUrl": "",
"allowUserToAddDestination": false
}
],
"invitationMessage": "Dear User, please sign the document attached.",
"invitationSubject": "Document Signature Request"
}Responses
HTTP 200 — Multi-step invitation created
{
"data": [
{
"id": "",
"subject": "",
"message": "",
"name": "",
"signeOrder": 0,
"destinationType": 1,
"authenticationType": 7,
"destination": "",
"fileId": "",
"status": 1,
"userHost": "",
"invitationLink": "",
"invitationLanguage": 0
}
],
"errorCode": 0,
"message": null,
"returnUrl": "",
"stateValidationErrors": null,
"signature": ""
}