Archive envelope

AI Tools

The Yoti Sign API has an ‘archive’ function. This allows senders to cancel an envelope that has been sent for signing, but has not yet been signed by all recipients. The envelope will then no longer be available for signing.

HTTP
    
 
Sandbox:PATCH https://demo.api.yotisign.com/v2/envelopes/<envelopeId>
Copy

HTTP
    
 
Production:PATCH https://api.yotisign.com/v2/envelopes/<envelopeId>
Copy

The Archive Envelope endpoint returns a status code of 204 if successful.

Example code

Javascript
Java
PHP
C#
Go
    
​x
 
const rp = require("request-promise");const archiveEnvelope = () => {  const request = {    method: "PATCH",    uri: "<BASE_URL>/v2/envelopes/<envelopeId>",    headers: {      authorization: "Bearer <API_KEY>",    },  };​  return rp(request)    .then((body) => body)    .catch((err) => err);};​//send requestlet result = await archiveEnvelope();
Copy

Error codes

If the request is unsuccessful a response code and a message will be sent

Last updated on

Was this page helpful?