Generate Completed Link

This endpoint generates a unique, shareable link for a completed project. It is typically used to provide access to finalized project documents or results, allowing recipients to view or download the completed materials securely.

Endpoint

POST {{host}}/api/v2/projects/:projectId/link/completed?email={email}

• Method: POST

• Base URL Variable: {{host}} (set in your environment, e.g., https://api.staging.example.com)

Path Variables

• uuid (string, required):

  • The unique identifier of the project for which you want to generate the completed link.

  • This can be provided directly in the URL or via the project-uuid environment variable.

Query Parameters

• email (string, required):

  • The recipient's email address to whom the completed link will be sent.

  • Example: [email protected]

Required Headers / Authentication

• Authorization: Bearer {USER-TOKEN}
  • A valid bearer token for authentication. Set the user-token variable in your environment.
• Additional headers may be required depending on your API security setup.

Example Request

POST {{host}}/api/v2/projects/SECd02qFXnNCvGE/link/[email protected]
Headers:
  Authorization: Bearer {USER-TOKEN}

Request Body

• This endpoint does not require a request body. Leave the body empty.

Expected Responses

• 200 OK

  • Returns a JSON object containing the generated completed link.

  • Example response:

    JSON

    {
      "completed_link": "https://example.com/completed/SECd02qFXnNCvGE/unique-token"
    }
    

• 400 Bad Request
  • Returned if required parameters are missing or invalid.
• 401 Unauthorized
  • Returned if the authentication token is missing or invalid.
• 404 Not Found
  • Returned if the specified project does not exist.

Notes

• Ensure all required environment variables (host, user-token, project-uuid) are set before sending the request.

• For more information, refer to the collection documentation or contact your API administrator.

Related Reference

See the GENERATE COMPLETED LINK reference request for additional details or variations.