SIsignnow

Bulk invite

This endpoint allows API users to create multiple invites to different signers from one template. A new document is generated for each signer and stored in the needed folder.

To create a bulk invite, you need a CSV file with signers' roles, emails, and document names. The format is the following:

For one role


Recipient 1|signer1@email.com,document_name
Recipient 1|signer2@email.com,document_name

For multiple roles


Recipient 1|signer1@email.com,Recipient 2|signer2@email.com,document_name1
Recipient 1|signer3@email.com,Recipient 2|signer4@email.com,document_name2

All the roles in the CSV must be assigned to at least one field in the template, and all the roles that exist in the template must be in the CSV.

post/template/{document_id}/bulkinvite

Request

Path parameters

unique id of the template

Request body multipart/form-data

fileunknown required
folder_idstring required

ID of the folder to store the documents in. To find the ID, use GET /user/folder.

subjectstring

Custom email subject for all signers

email_messagestring

Custom email message for all signers

client_timestampinteger

The timestamp in UNIX code

signature_typestring

Type of QES signature requested from signers. Possible values: eideasy, eideasy-pdf, nom151. Available to members of an organization with QES settings enabled. For more information, see the QES user guide.

Response

The bulk invite was queued. Documents are created and invites are sent in the background.

statusstring

Status of the bulk invite job. Always job queued.

Changes

No recorded changes to this operation across all 1 revision of this API.