API Documentation
Syncpoint DELETE

delete

Syncpoint DELETE

Removes an existing Syncpoint from the Syncplicity account.
Required Scope: Files/Folder Metadata, Delete

 

URL Parameters

  • Param Name
    Type
    Description
  • SYNCPOINT_ID
    string
    ID of the syncpoint

Resource URL

https://api.syncplicity.com/ syncpoint/syncpoint.svc/{SYNCPOINT_ID}

Query Parameters


Name Values Description
modifier

If equals 'permanently' - will mark the syncpoint for purging. Valid only for non-active (deleted) syncpoints


Header Parameters


Name Values Description
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.

AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Content-Type

Content-Type of the request

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
  • 403
    403

    (Forbidden) - Not A Business - Admin Current user is not an administrator and the "user" query parameter is specified
    (Forbidden) - User Not Authorized For Action
    (Forbidden) - Virtual Folder Is Shared Via The Group Permissions
    (Forbidden) - Deleting Private Folder Not Allowed
    (Forbidden) - Purging SubFolder Shares Is Not Allowed

Working...