Sign in

v1

latestOpenAPI 3.0.12026-07-242682197.7 KB
Document

Update Authentication

Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.

patch/api/v1/documents/{id}/authentication

Path parameters

idstring uuid required

Unique identifier for a document.

Request body

Response

successful

test_modeboolean required
idstring required
api_application_idstring uuid nullable
requester_email_addressstring email
custom_requester_namestring nullable
custom_requester_emailstring email nullable
namestring
subjectstring
messagestring
metadataobject nullable
created_atstring date-time
updated_atstring date-time
statusstring

Possible values: Draft, Created, Sending, Sent, Pending, Viewed, Completed, Manually completed, Declined, Canceled, Bounced, Blocked, Error, Expired

remindersboolean
archivedboolean
embedded_signingboolean
embedded_edit_urlstring url nullable
embedded_preview_urlstring url nullable
apply_signing_orderboolean
redirect_urlstring url nullable
decline_redirect_urlstring url nullable
languagestring
expires_ininteger
decline_messagestring nullable
error_messagestring nullable
template_idstring nullable
template_idsstring[]
embedded_signing_notificationsboolean
allow_declineboolean nullable
allow_reassignboolean nullable