v1
documents

Revise Document

Copy a changes-requested envelope into a new unsent Draft.

The draft keeps the source's documents, fields, recipients and public metadata, with metadata.revision_of set to the source id. Edit it with the /api/v1/documents/drafts routes, then send it with POST /api/v1/documents/drafts/{document_id}/send; revision_of is carried on send, so the first qualifying revision is free while the promotion is enabled. No credit is charged here.

404 when the document is missing or belongs to another org. 409 not_changes_requested unless the newest session was declined with a change request. API-key twin of the dashboard POST /api/documents/{document_id}/revise.

post/api/v1/documents/{document_id}/revise

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/{document_id}/revise
  • Auth: HTTP bearer

Path parameters

document_idstring uuid required

Response

Successful Response

document_idstring uuid required
status'draft' | 'ready_to_send' required
namestring required
filenamestring required
parsed_fieldsobject[] required
partiesstring[] required
metadataobject nullable
credits_chargedinteger
sentboolean
revisioninteger
package_file_countinteger

Changes

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