API Documentation
Folder DELETE

delete

Folder DELETE

Delete a given folder and all of its contents.
Required Scope: Folders, Delete

 

URL Parameters

  • Param Name
    Type
    Description
  • SYNCPOINT_ID
    string
    ID associated with the target syncpoint
  • FOLDER_ID
    string
    ID associated with the folder within the syncpoint

Resource URL

https://api.syncplicity.com/ sync/folder.svc/{SYNCPOINT_ID}/folder/{FOLDER_ID}

Query Parameters


Name Values Description
modifier

When the value is "permanently" this deletes the folder and contents permanently. When empty or not set, the folder and contents can be restored based on file retention policies set by the administrator.


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

    (Bad request) - Invalid Folder ID

Working...