REST API: Delete File

Anonymous User

Published: 5/6/2015

Grace Kamau

Updated: 2/25/2021

0 (0votes)

Delete File

Delete a file and move it to the recycle bin. Valid for Communifire version 5.2 and above.

HTTP Method

DELETE

Response Format

JSON

Requires Authentication?

YES

Product Version

5.2 and above

Required Parameters	How to use	Description
API Key	Used in the request URL: &token=x OR Set in header: request.Headers.Add(Rest-Api-Key, x)	Communifire REST API key for the Communifire portal you are making the call for.
ContentID	Used in the request URL as a path parameter	Unique identifier for a particular file.

A status message is returned as ResponseMessage.

{
    "IsError":false,
    "ResponseMessage":"File deleted successfully",
    "ResponseData":2304
}

Please Note The content type that you pass in the header of your request should be application/json.