Create a Document Using an Existing Template

post

https://ext.edusign.fr/v2/documents/{templateId}

Allows the creation of a document using an existing template by providing the template ID in the request parameters.

INFO This method only allows sending documents with a signature field. If you try to use the ID of a template without a signature field, an error will be returned.

INFO: You can get the list of entries by querying the template by its ID, allowing you to access the ID and the label of all entries, like admin inputs label or id.

Path Params

templateId

string

required

Template ID

Body Params

directoryId

string

Sélectionnez le dossier existant dans lequel vous souhaitez enregistrer les documents que vous créez

trainingId

string

ID of the training to which you want to link the documents you're creating

sendDocumentToSignByEmail

string

Defaults to true

This field is used to choose whether the document should be sent by email to all recipients to allow them to sign it. Default: true

sendDocumentByEmailWhenCompleted

string

Defaults to true

This field is used to choose whether the document should be sent by email to all recipients once fully signed. Default: true

redirectionLinkOnceSigned

string

Redirigez l'utilisateur vers une URL spécifique une fois qu'il a signé

signatureValidationMethod

string

Defaults to email

Allowed values: "email", "sms", "none" (none makes signature validation optional). Default: "email"

signWithOrder

boolean

Defaults to false

This field allows sending the document to the recipients one after another only when the previous recipient has signed.

expirationDate

string

This field allows you to set a date after which it will no longer be possible to sign the document.

attachedDocuments

array of objects

attachedDocuments

sendCustomDocumentEmail

object

sendCustomSignatureReminderEmail

object

sendCustomEmailWhenDocumentCompleted

object

admin

object

Administrator's data

recipients

array of arrays of objects

required

An array containing arrays of recipients for each document to be sent
Each array of recipients represents a document that will be sent. All recipient arrays must be identical (same number of recipients in the same order), only the IDs must be different from one array to another WARNING : All recipient arrays must be identical (same number of recipients in the same order), only the IDs must be different from one array to another

recipients*

attachedDocuments[name]

string

Nom du document joint (requis si attachedDocuments est envoyé)

attachedDocuments[url]

string

URL du document joint (requis si attachedDocuments est envoyé)

Response

200Success-Response: