Create eSignature Request

post

https://api.sisu.co/api/v3/esign-request

Creates an eSignature request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The payload body for creating an eSignature request.

esig_template_id

integer

required

The ID of the template to send

signers

array of objects

required

The list of signers, their email addresses, contact ID if applicable, and pre-filled field values.

Signers*

client_id

The ID of the transaction

expire_at_days

The number of days before the eSignature should expire. Defaults to 7 when not supplied, unless the team has set their own preferred expiration time.

signature_order

ESignatureOrder | null

Defaults to P

The order to send signatures, currently only supports sending in parallel.

email_config

ESignatureRequestEmailConfig | null

The e-mail configuration for this eSignature request. Role-specific subject/message will override the default. If no default is given, the team or system default will be used.

preview_mode

Enables preview mode, which disabled sending emails and hides this eSignature from queries. Used for when you want to test an eSignature before sending. Should be used in combination with the preview mode of the form builder for viewing.

send_esignature

boolean

Defaults to true

When False, skips DocuSeal submission creation and email sending entirely. Only applies transaction field updates from the signer field values. Useful for updating a transaction from form data before calling /options to retrieve fresh values and then sending the real request.

Responses

200Success

406Error