Generate Signing Link for Project

Endpoint: POST {{host}}/api/v2/projects/:uuid/link/[email protected]

Purpose

This endpoint generates a unique, signable link for a specific project. The generated link can be sent to a user via email, allowing them to access and sign project-related documents securely.

HTTP Method

POST

Endpoint URL

{{host}}/api/v2/projects/:uuid/link/[email protected]

Path Variables

• :uuid (string, required): The unique identifier of the project for which the signing link is being generated. Replace :uuid with the actual project UUID.

Query Parameters

• email (string, required): The email address of the recipient who will receive the signing link. Example: [email protected]

Request Body

• No request body is required for this endpoint.

Usage Instructions

1. Replace {{host}} with your API host (e.g., https://api.example.com).

2. Replace :uuid in the URL path with the actual project UUID.

3. Set the email query parameter to the recipient's email address.

4. Send a POST request to the endpoint. No body is required.

5. On success, the response will include a unique signing link for the specified project and recipient.

Example Request

POST https://api.example.com/api/v2/projects/123e4567-e89b-12d3-a456-426614174000/link/[email protected]

Response

• 200 OK: Returns a JSON object containing the generated signing link and related metadata.

• 4xx/5xx: Returns an error object with details about the failure (e.g., invalid UUID, missing email, etc.).

Note: Use this endpoint to automate the process of sending signing links to users for project-related documents. Ensure the recipient's email is valid and the project UUID exists in your system.