Documents

Update a document

Update document properties during the lifecycle of the document, from draft to signed. Which properties can be updated depends on the current document status, and a request with any other property is rejected with 400.

A draft document accepts external_id, external_client_id, is_private, value, comment_settings, sign_redirect, block_recipient_invite and sign_copy_emails. Any later status accepts value, contract_start_date, contract_end_date, tags, is_private, comment_settings, sign_redirect, block_recipient_invite and sign_copy_emails.

put/v1/documents/{id}

Request

  • Base URL: https://api.getaccept.com
  • URL: https://api.getaccept.com/v1/documents/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Id of the document.

Request body

external_idstring

Change the external id of the document.

external_client_idstring

Replaces the client stored on the document, as returned in external_client_id by get document. Only accepted while the document is a draft.

valuenumber

Monetary value of the document, 0 or higher. Rejected with 403 when a conditional logic condition on the document uses the document value and at least one recipient has signed or approved the document.

tagsstring

Comma separated tag titles to add to the document, without spaces around the commas, for example POC,Europe,ICP. Tags already on the document are kept, and a title that matches no tag of the entity creates that tag.

is_privateboolean nullable

When true the document can only be viewed by the owner.

sign_redirectstring

HTTPS URL the recipient is redirected to after signing, taking precedence over the entity sign redirect. Merge tags may not appear in the host, and {{customData.key}} tags only as query parameter values. Requires extended branding. Replaces the current document sign redirect.

block_recipient_inviteboolean

Blocks recipients from inviting additional participants from the signing page.

sign_copy_emailsstring[] nullable

Up to 10 email addresses that receive an email copy of the signed document once everyone has signed. They are not recipients: they are never invited, not shown to signers and not on the certificate. Replaces the current addresses; send null or an empty array to remove them all.

Response

The request succeeded. The response has no body.

Changes

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