Skip to content
calternal docs

Move Files items to Trash

POST
/api/v1/files/trash
curl --request POST \
  --url https://example.com/api/v1/files/trash \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[ { "path": "example" } ]'

Requires a signed-in User with the data scope and permission to change each Item. It returns the paths that could not be moved when part of the request fails, or 400 when the request is invalid. Route: /api/v1/files/trash. Inputs: . Do not automatically replay this operation after an uncertain result.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
Array<object>
object
path
required
string
Examplegenerated
[
  {
    "path": "example"
  }
]

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<string>
Examplegenerated
[
  "example"
]

400

Section titled “400”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}