Send Signature Request By Templat

This endpoint allows enterprise users to initiate a signature workflow based on a predefined template. It is designed to efficiently send documents for signature to multiple recipients by specifying recipient details, email content, and optional project settings.

HTTP Method and URL

• Method: POST

• URL: {{host}}/api/v2/templates/signs?user_type=ENTERPRISE_API

Authentication Requirements

Authentication is required to access this endpoint. Ensure that a valid user token is included in the request headers as per your organization's authentication scheme.

Path and Query Parameters

• user_type (query parameter, required): Must be set to ENTERPRISE_API.

Request Body

The request body must be sent as multipart/form-data and include the following fields:

• template_id (string, required): Unique identifier of the template to use for the signature request.

• email_address[n] (string, required): Email addresses of the recipients. Use indexed keys (e.g., email_address[0], email_address[1], etc.) for multiple recipients.

• first_name[n], middle_name[n], last_name[n] (string, required): Name details for each recipient, using the same index as their email address.

• email_sender (string, optional): The sender's email address.

• email_subject (string, optional): Subject line for the signature request email.

• email_message (string, optional): Custom message to include in the email.

• project_description (string, optional): Description of the signature project.

• project_setting[custom_completion_page] (string, optional): URL for a custom completion page after signing.

• project_setting[custom_completion_page_color] (string, optional): Color theme for the completion page.

• project_setting[vault_access] (string, optional): Vault access settings.

• project_setting[sign_page_custom_branding] (string, optional): Custom branding for the signing page.

Example Request

POST {{host}}/api/v2/templates/signs?user_type=ENTERPRISE_API
Content-Type: multipart/form-data
Authorization: Bearer <user-token>
Form Data:
template_id=3
email_address[0][email protected]
email_address[1][email protected]
first_name[0]=John
middle_name[0]=A.
last_name[0]=Doe
first_name[1]=Jane
middle_name[1]=B.
last_name[1]=Smith
[email protected]
email_subject=Please Sign the Document
email_message=Kindly review and sign the attached document.
project_description=Signature workflow for contract agreement.
project_setting[custom_completion_page]=https://example.com/completion
project_setting[custom_completion_page_color]=#123456
project_setting[vault_access]=enabled
project_setting[sign_page_custom_branding]=BrandX

Example Successful Response

{
  "message": "",
  "data": {
    "project": {
      "uuid": "<project-uuid>",
      "template_id": "3",
      "status": "created",
      "recipients": [
        {
          "email": "[email protected]",
          "name": "John A. Doe"
        },
        {
          "email": "[email protected]",
          "name": "Jane B. Smith"
        }
      ],
      "created_at": "2024-06-01T12:00:00Z"
    }
  }
}

Error Responses

• 400 Bad Request: Missing or invalid required fields.

• 401 Unauthorized: Authentication failed or missing token.

• 403 Forbidden: Insufficient permissions to perform this action.

• 404 Not Found: Specified template does not exist.

• 500 Internal Server Error: An unexpected error occurred on the server.

Usage Notes

• Ensure that all recipient fields use consistent indexing (e.g., email_address[0], first_name[0], etc.).

• Optional fields can be omitted if not needed.

• The response includes the unique project UUID, which can be used for tracking or further API interactions.

• For best results, validate all input data before sending the request.