Send Reminders

AI Tools

The Yoti Sign API has an ‘send-reminder’ function. This allows you to send recipients a reminder to sign an envelope.

HTTP
    
 
Sandbox: POST https://demo.api.yotisign.com/v2/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder
Copy

HTTP
    
 
Production: POST https://api.yotisign.com/v2/envelopes/{envelope_id}/recipients/{recipient_id}/send-reminder
Copy

Headers explained

The following elements are needed:

Headers	Content
Authorization	API Key to call the Yoti Sign API. This should be sent as a bearer token.
Content-Type	application/json

Example code

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

Example Response

JSON
    
 
{  "recipient_id": {{ recipient_id }}}
Copy

Error codes

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

Last updated on

Was this page helpful?