Resend Signing Emails
This guide walks you through resending signing invitation emails to specific participants in an eSignature transaction using the Stewart Sign API.
When to Use
Resending signing emails is useful when:
- A participant did not receive the original signing invitation
- The signing link has expired and needs to be refreshed
- A participant accidentally deleted the email
- You need to remind specific signers to complete their signatures
Requirements
- You need to have Node.js installed on your system.
- You'll also need the axios library. You can install it using the following command:
npm install axios
- A valid Bearer token (JWT) for authentication.
- The eSign session ID (or transaction ID) of the session.
- One or more signer IDs (participant UUIDs) to resend emails to.
Endpoint
POST /esign/{id}/resend-email
| Parameter | Type | Location | Required | Description |
|---|---|---|---|---|
id | string (UUID) | Path | Yes | The eSign session ID or transaction ID. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
signerIds | array of string (UUID) | Yes | List of participant IDs to resend the signing email to. Must contain at least one ID. |
Code Snippet
Use the following code snippet to resend signing emails. Replace <esignId> with the eSign session ID, and <accessToken> with your API access token.
const axios = require("axios");
const esignId = "<esignId>";
const config = {
method: "post",
url: `https://public-api.sign.stewart.com/esign/${esignId}/resend-email`,
headers: {
Authorization: "Bearer <accessToken>",
"Content-Type": "application/json",
},
data: {
signerIds: [
"37da192e-6420-4b9c-9951-a979eeaf8889",
"5e7ec62e-e983-48b3-9788-4309c7a50b2f",
],
},
};
axios(config)
.then(function (response) {
console.log("Emails resent successfully:", response.data);
})
.catch(function (error) {
console.log(error.response?.data || error.message);
});
Successful Response
On success, the API returns a confirmation from the Transaction service.
Error Responses
| Status | Reason |
|---|---|
400 Bad Request | The id is not a valid UUID, or signerIds is empty or missing |
404 Not Found | No eSign session found with the provided ID, or signer ID not found |
Error Response Format
{
"detail": "Invalid property parameter submitted for `signerIds`.",
"error": "enl-api-400",
"message": "Bad request. Validation error.",
"help": "https://integration.sign.stewart.com/docs/troubleshooting/enl-api-400"
}
Steps to Execute the Code Snippet
- Create a new file named
resend_email.js. - Copy and paste the code snippet provided above into the new file.
- Replace
<esignId>and<accessToken>with the appropriate values. - Update the
signerIdsarray with the actual participant IDs. - Save the file and open a terminal or command prompt.
- Navigate to the folder where you saved the
resend_email.jsfile. - Run the following command to execute the script:
node resend_email.js
If the request is successful, you'll see a confirmation message. In case of an error, the error details will be displayed instead.
Additional Resources
For more information about the eSignature API, visit the API reference.
If you need further assistance or have questions, feel free to reach out to our support team.