Envelope

Update envelope

Update envelope properties and settings

post/envelope/update

Request

  • Base URL
    https://app.documenso.com/api/v2
  • Auth
    API key in header Authorization

Request body

envelopeIdstring required

Response

Successful response

internalVersionnumber required
type'DOCUMENT' | 'TEMPLATE' required
status'DRAFT' | 'PENDING' | 'COMPLETED' | 'REJECTED' | 'CANCELLED' required
source'DOCUMENT' | 'TEMPLATE' | 'TEMPLATE_DIRECT_LINK' required
visibility'EVERYONE' | 'MANAGER_AND_ABOVE' | 'ADMIN' required
templateType'PUBLIC' | 'PRIVATE' | 'ORGANISATION' required
idstring required
secondaryIdstring required
externalIdstring nullable required
createdAtstring required
updatedAtstring required
completedAtstring nullable required
deletedAtstring nullable required
titlestring required
formValuesobject nullable required
publicTitlestring required
publicDescriptionstring required
userIdnumber required
teamIdnumber required
folderIdstring nullable required

Changes

No recorded changes to this operation across all 7 revisions of this API.