Skip to content
Select language:English

/api/v1/places/{id}/trash

POST
/api/v1/places/{id}/trash
curl --request POST \
--url https://example.com/api/v1/places/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/trash \
--header 'Content-Type: application/json' \
--data '{ "contents": "move", "moveTo": { "placeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Media typeapplication/json
object
contents
string
Allowed values: move trash
moveTo
Any of:
object
placeId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Default Response

Media typeapplication/json
object
trashed
required
Array<string>
moved
required
Array<string>
trashBatchId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Examplegenerated
{
"trashed": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"moved": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"trashBatchId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}