Skip to content

Latest commit

History

History
48 lines (44 loc) · 4.62 KB

File metadata and controls

48 lines (44 loc) · 4.62 KB

SignRequestQuickCreate

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[optional]
integrationstr[optional]
integration_dataobject[optional]
namestrDefaults to filename, including extension[optional]
external_idstrID used to reference document in external system[optional]
frontend_idstrShared secret used in conjunction with <a href=&quot;#section/Frontend-API/SignRequest-js-client-(beta)&quot;>SignRequest-js client</a> to grant user access to a document that's not a member of the document's team[optional]
filestrTemporary URL to original file, expires in five minutes[optional]
file_from_urlstrPublicly accessible URL of document to be downloaded by SignRequest[optional]
events_callback_urlstrURL at which to receive event callbacks for this document[optional]
file_from_contentstrBase64 encoded document content[optional]
file_from_content_namestrFilename, including extension. Required when using `file_from_content`.[optional]
templatestr[optional]
prefill_tagslist[InlinePrefillTags]Prefill signer input data, see prefill tags[optional]
integrationslist[InlineIntegrationData][optional]
file_from_sfFileFromSf[optional]
auto_delete_daysintNumber of days after which a finished document (signed/cancelled/declined) will be automatically deleted[optional]
auto_expire_daysintNumber of days after which a non finished document will be automatically expired[optional]

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