POST /api/v1/invitations/bulk/send — Send Bulk Invitations
Send signing invitations to multiple recipients across multiple envelopes in a single API call. Useful for high-volume signing workflows.
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 (same as Send Invitation).
- 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.
[
{
"documentId": "772ad332-a04a-48c4-a04c-176aa04b3cf5",
"destinations": [
{
"destinationName": "string",
"destinationEmail": "string@gmail.com",
"destinationPhoneNumber": "",
"signatories": [],
"ConsentOnly": true
}
]
},
{
"documentId": "945421fb-7e9b-47b7-b1dd-7274d13ca027",
"destinations": [
{
"destinationName": "string",
"destinationEmail": "string+1@gmail.com",
"destinationPhoneNumber": "",
"signatories": [],
"ConsentOnly": true
}
]
}
]Responses
HTTP 200 — Bulk invitations sent
{
"data": true,
"errorCode": 0,
"message": null,
"returnUrl": "/dashboard",
"stateValidationErrors": null,
"signature": ""
}