Move a Project into Trash

Moves a specific active signature request document (project) to the trash. This action changes the document's status to "Deleted", making all email links to the document inaccessible. The document remains in the trash indefinitely and can be restored or permanently deleted later.

HTTP Method and URL

• Method: PUT

• URL: {{host}}/my/projects/:uuid/trash?user_type=ENTERPRISE_API

Authentication Requirements

This endpoint requires authentication. Include the following header:

Authorization: Bearer {USER-TOKEN}

Path and Query Parameters

• Path Parameter:

  • uuid (string, required): The unique identifier of the project to move to trash. Use {{project-uuid}} as the variable.

• Query Parameter:

  • user_type (string, required): The type of user making the request. For this endpoint, use ENTERPRISE_API.

Example Request

PUT {{host}}/my/projects/{{project-uuid}}/trash?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}

Example Successful Response

Content-Type: application/json

{
  "message": ""
}

Error Responses

• 401 Unauthorized

  • The request is missing a valid authentication token or the token is invalid.

  • Example:

    JSON

          {
            "message": "Unauthorized: Invalid or missing authentication token."
          }
    

• 404 Not Found

  • The specified project UUID does not exist or is not accessible.

  • Example:

    JSON

          {
            "message": "Project not found."
          }
    

Usage Notes

• Once a project is moved to trash, all associated email links become inaccessible.

• Projects in the trash can be restored or permanently deleted via other endpoints.

• Ensure you have the correct uuid and appropriate permissions before making this request.