POST /api/v1/invitations — Send Invitation
Send a signing invitation to a recipient for a specific envelope. The recipient receives an email or SMS with a link to sign the document.
Authentication
SadqAuthorize
Request Headers
- Authorization (required)
- Bearer {token}
- Content-Type (required)
- application/json
Request Body
Content-Type: application/json
- DocumentId (GUID, required)
- The unique identifier of the document
- destinations (array, required)
- Array of destination objects (recipients).
- invitationMessage (string, optional)
- Custom message to include in the invitation.
- invitationSubject (string, optional)
- Subject of the invitation email.
- sendUserInvitation (boolean, optional)
- Whether to send invitation to the user.
- customSmsMessage (string, optional)
- Custom SMS message for notifications.
- creatorFields (object, optional)
- Custom fields defined by the creator.
- qrCodes (array, optional)
{
"DocumentId": "9af7cb57-436f-40e9-b05c-75d05732db1c",
"Destinations": [
{
"DestinationName": "Ahmed Al-Rashid",
"DestinationEmail": "ahmed.alrashid@example.com",
"DestinationPhoneNumber": "+966501234567",
"signatories": [],
"ConsentOnly": true,
"AuthenticationType": 0
}
]
}Responses
HTTP 200 — Invitation sent successfully
{
"data": true,
"errorCode": 0,
"message": null,
"returnUrl": "/dashboard",
"stateValidationErrors": null,
"signature": ""
}