v1
documents

Send Draft

Debit one credit and send a previously created draft.

Recipients default to those stored at create time when omitted here.

post/api/v1/documents/drafts/{document_id}/send

Request

  • Base URL: https://zsign.io (the document declares no server; this is the origin it was published from)
  • URL: https://zsign.io/api/v1/documents/drafts/{document_id}/send
  • Auth: HTTP bearer

Path parameters

document_idstring uuid required

Request body

metadataobject nullable
send_inviteboolean
send_completion_emailboolean
sequentialboolean

Whether recipients must sign in list order. Same flag as DocumentSendRequest.sequential. True (default) is one at a time; false is everyone at once.

prefillobject nullable

Per-send text values keyed by field "party:name". Sets or overrides each text field's default_value for this send only. Unknown or non-text keys are a 422 invalid_prefill_key.

Response

Successful Response

document_idstring uuid required
session_idstring uuid required
parsed_fieldsobject[] required
filenamestring nullable
package_file_countinteger

Changes

No recorded changes to this operation across all 1 revision of this API.