Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

deleteFile


The deleteFile() method removes a file from your Library. If the file to delete is a non-empty directory, then
the “force” argument must be present to avoid a fault being thrown.

Input

[vrtypens:deleteFileArgs]

session_id [xsd:string] (required)
Your API session id.
file [xsd:string] (required)
Library path to file to delete (e.g., “/logos/fall.jpg”).
move_to_trash [xsd:boolean]
Whether to just move the file to /Trash instead of deleting it outright.
force [xsd:boolean]
Whether to prevent a fault from being thrown if the file to delete is a non-empty directory.

Output

[xsd:boolean]

Examples

Perl

$vrapi->deleteFile( {
    session_id => $sid,
    files      => '/foo/bar',
    force      => 1,
} );

PHP

$vrapi->deleteFile( array(
    'session_id' => $sid,
    'files'      => '/foo/bar',
    'force'      => 1,
) );