Skip to content

Latest commit

History

History
34 lines (30 loc) · 2.96 KB

File metadata and controls

34 lines (30 loc) · 2.96 KB

SignRequest

Properties

NameTypeDescriptionNotes
from_emailstrEmail of user sending the SignRequest (must be a validated email)[optional]
from_email_namestrName to be used in the `From` email header, e.g. `{from_email_name} <no-reply@signrequest.com>`[optional]
is_being_preparedboolHave the sender of a SignRequest prepare the document before sending the request out, see: prepare using the web interface[optional]
prepare_urlstr[optional]
redirect_urlstrURL at which SignRequest will redirect to when a document is signed[optional]
redirect_url_declinedstrURL at which SignRequest will redirect to when a document is declined[optional]
required_attachmentslist[RequiredAttachment]Attachments that signers are required to upload[optional]
disable_attachmentsboolDisable uploading/adding of attachments[optional]
disable_text_signaturesboolDisable usage of signatures generated by typing (text)[optional]
disable_textboolDisable adding of text[optional]
disable_dateboolDisable adding of dates[optional]
disable_emailsboolDisable all SignRequest status emails as well as the email that contains the signed documents[optional]
disable_upload_signaturesboolDisable usage of uploaded signatures (images)[optional]
disable_blockchain_proofboolDisables storing timestamp proof hashes in blockchain integrations.[optional]
text_message_verification_lockedboolWhen true a text message verification is needed before the signer can see the document[optional]
subjectstrSubject of SignRequest email[optional]
messagestrMessage to include in SignRequest email, may contain the following html tags: `a`, `abbr`, `acronym`, `b`, `blockquote`, `code`, `em`, `i`, `ul`, `li`, `ol`, and `strong`[optional]
whostr`m`: only me, `mo`: me and others, `o`: only others[optional] [default to 'o']
send_remindersboolAutomatically remind signers to sign a document, see: automatic reminders[optional]
signerslist[Signer]
uuidstr[optional]
urlstr[optional]
documentstr
integrationstr[optional]
integration_dataobject[optional]

[Back to Model list][Back to API list][Back to README]