API Documentation
File by Id DELETE

delete

File by Id DELETE

Delete a file by syncpoint ID and file ID.
Required Scope: Files, Delete

 

URL Parameters

  • Param Name
    Type
    Description
  • SYNCPOINT_ID
    string
    ID associated with the file syncpoint
  • FILE_VERSION_ID
    string
    Version ID of the target file

Resource URL

https://api.syncplicity.com/ sync/file.svc/{SYNCPOINT_ID}/file/{FILE_VERSION_ID}

Query Parameters


Name Values Description
modifier

Set the value to "permanently" delete a file permanently


Header Parameters


Name Values Description
Accept
(required)

application/json

AppKey
(required)

Consumer Key of the app from Developer Portal

As-User

A Global Administrator, or eDiscovery Administrator who has been assigned the corresponding privilege, can enter another user’s GUID so that all Content API actions are performed on behalf of that user.
If this header is not used or the Administrator has not been assigned the corresponding privilege, the API works on behalf of the currently authenticated Global or eDiscovery Administrator.

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    Invalid SyncPoint ID
    Invalid Version ID
    Mismatched SyncPoint ID
    Purging Active File Not Allowed (only if modifier=permanently)
    File Already Deleted

  • 403
    403

    User Not Authorized For Action

Working...