Skip to main content
POST
Restore a sequence folder from Trash

Authorizations

X-API-Key
string
header
required

Path Parameters

folder_id
string<uuid>
required

Query Parameters

dry_run
boolean
default:false

Report what would come back, and restore nothing.

Response

Successful Response

What restoring a sequence folder brought back.

contacts_held_elsewhere
integer
required

Their contacts another sequence took while they were in Trash, which stay stopped. The rest are taken back where they stood, in the background.

folder
SequenceFolderSchema · object
required

A folder on the Sequences list.

folder_count
integer
required

Folders that came back, this one included.

left_in_trash_sequence_ids
string<uuid>[]
required

Sequences that stayed in Trash because a live sequence has taken their name since. Each is now listed in Trash on its own.

sequence_ids
string<uuid>[]
required

Sequences that came back with it, paused.