Purpose
Generate a one-time, signed link that allows a participant to re-open the signing session and update their signature on an existing project/document.

HTTP

• Method: POST
• URL: {{host}}/api/v2/projects/:projectUuid/link/signed?email={{email}}
  • {{host}}: Base URL of the API environment (e.g., https://staging.api.example.com)
  • :projectUuid (path): The UUID of the project. Type: string (UUID-like). Example: obXX3gPwHAOHpVx

Path Parameters

• projectUuid (required, string): Identifier of the target project/document.

Query Parameters

• email (required, string, email): Email address of the participant for whom the signature update link is generated. Example: [email protected]

Request Body

• None. This endpoint does not accept a request body.

Authentication

• Inherits authentication from the collection/folder. Ensure the required auth (e.g., Bearer token) is configured in the parent scope before sending this request.

Responses

• 200 OK: Returns a JSON payload containing a one-time, signed link for the specified participant.
  Example response body:
  {
  "link": "https://app.example.com/sign/signed?token=eyJhbGciOi...",
  "expiresAt": "2025-01-31T23:59:59Z",
  "oneTime": true
  }

• 400 Bad Request: Invalid input (e.g., missing or malformed email, projectUuid).

• 401 Unauthorized: Authentication missing/invalid.

• 403 Forbidden: Authenticated user lacks permission for this project.

• 404 Not Found: Project or participant not found.

• 409 Conflict: A valid one-time link already exists and is not expired.

• 429 Too Many Requests: Rate limit exceeded.

• 5xx Server Error: Unexpected server error.

Notes

• Ensure the STAGING environment is active and that the host variable is defined; otherwise the URL will not resolve.
• The generated link is single-use and intended only for the participant identified by the email query parameter.
• If your API uses additional headers (e.g., X-Client-Key), confirm they are inherited from the collection/folder.

Example
curl --request POST
"{{host}}/api/v2/projects/:projectUuid/link/signed?email={{email}}"
--header "Authorization: Bearer {{user-token}}"