Envelopes/Initiate-And-Invite

Initiate-And-Invite

POSTSadq Auth

Create multiple envelopes in bulk and send invitations to recipients

Headers

Key	Value	Required
Authorization	Bearer {token}	Required
Content-Type	application/json	Required

Try It

Bearer Token

Request Body (application/json)

{
  "referenceNumber": "string (optional)",
  "workflowId": "string (guid, optional)",
  "isForExternalWorkFlow": "boolean (optional, default: false)",
  "files": [
    {
      "fileName": "string (required)",
      "fileContent": "string (required, base64)",
      "referenceNumber": "string (optional)"
    }
  ],
  "destinations": [
    {
      "destinationName": "string (required)",
      "destinationEmail": "string (required if no phone)",
      "destinationPhoneNumber": "string (required if no email)",
      "signeOrder": "integer (required)",
      "signatories": [
        {
          "signatureType": "string",
          "x": "number",
          "y": "number",
          "width": "number",
          "height": "number",
          "pageNumber": "integer"
        }
      ],
      "availableTo": "string (date-time, optional)",
      "consentOnly": "boolean (default: false)",
      "authenticationType": "integer (enum: 0=None, 1=OTP, 2=Nafath)",
      "allowUserToSignAnyWhere": "boolean (default: false)",
      "destinationType": "integer (enum: 0=Signer, 1=Viewer, 2=Approver)",
      "nationalId": "string (optional)",
      "invitationLanguage": "integer (optional)",
      "redirectUrl": "string (optional)",
      "allowUserToAddDestination": "boolean (default: false)",
      "delegaterId": "string (guid, optional)",
      "commercialNumber": "string (optional)",
      "uploadFile": {
        "fileName": "string",
        "fileContent": "string (base64)"
      },
      "dailyNotify": "boolean (default: false)",
      "escalation": {
        "emailOrPhoneNumber": "string",
        "numberOfDays": "integer"
      }
    }
  ],
  "SaveAsDraft": false
}

Request URL

https://sandbox-api.sadq-sa.com/api/v1/envelopes/bulk/initiate-and-invite