Move File To Trash

Moves a specific completed signature request document to the trash. You must provide the UUID of the document. If the document has multiple recipients, moving it to trash for one recipient (e.g., the creator) does not affect the trash status for other recipients.

HTTP Method and URL

Method: PUT

URL:

{{host}}/api/v2/vault/item/:uuid/trash?user_type=ENTERPRISE_API

Authentication Requirements

Requires valid authentication. Typically, an API key or bearer token must be included in the request headers.

Path and Query Parameters

Path Parameters:

• uuid (string): The UUID of the document to move to trash. Example: {{project-uuid}}

Query Parameters:

• user_type (string): Specifies the type of user. Example: ENTERPRISE_API

Example Request

PUT {{host}}/api/v2/vault/item/{{project-uuid}}/trash?user_type=ENTERPRISE_API
Authorization: Bearer {USER-TOKEN}

Example Successful Response

{
  "status": "success",
  "message": "Document moved to trash successfully.",
  "data": {
    "uuid": "{{project-uuid}}",
    "trashed": true,
    "trashed_at": "2024-01-01T12:00:00Z"
  }
}

Error Responses

• 401 Unauthorized: Authentication failed or missing credentials.

• 404 Not Found: The specified document UUID does not exist or is not accessible.

Usage Notes

• Moving a document to trash is recipient-specific. Other recipients will still see the document unless they also move it to trash.

• Ensure you have the correct permissions and provide a valid UUID.

• The user_type query parameter must be set to ENTERPRISE_API.