v1

latestOpenAPI 3.0.12026-07-242682197.7 KB

Document

Update Recipients

Updates one or more recipients on a document that has already been sent. Only recipients who have not started signing may be updated. Recipient IDs must be retrieved from the Get Document response. Allowed document statuses: sent, viewed, pending, bounced. For non-embedded documents, updated recipients will receive a new notification email. For embedded signing documents, email behavior follows each recipient's send_email setting.

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

Path parameters

idstring uuid required

Unique identifier for a document.

Request body

Example request

{
  "recipients": [
    {
      "email": "jane@example.com"
    }
  ]
}

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