Skip to main content
DELETE
Delete a sequence folder

Authorizations

X-API-Key
string
header
required

Path Parameters

folder_id
string<uuid>
required

Query Parameters

permanently
boolean
default:false

Destroy a folder already in Trash for good, instead of trashing it.

dry_run
boolean
default:false

Report what would be deleted, and delete nothing.

Response

Successful Response

What deleting a sequence folder, to Trash or for good, took with it.

detail
string
required

The detail of why the resource was deleted.

count
integer
default:1

The folders that went: this one and every folder in it.

left_in_trash_sequence_ids
string<uuid>[]

For good only: sequences that could not be deleted this time. They keep the folder in Trash, listing them; try again.

paused_count
integer
default:0

To Trash only: how many of them were running and pause, letting their contacts go, as a sequence moved to Trash on its own does.

sequence_ids
string<uuid>[]

The sequences that went with it: to Trash, where they come back with the folder, or for good.