API Documentation
Syncpoint Participants POST

post

Syncpoint Participants POST

Shares a Syncpoint with one or more Syncplicity users or user groups. If the Syncpoint is already shared with the specified participant, the API will then behave as an update for the permissions instead. Sharing will be performed to the list of users, or the list of groups, not to both.
Required Scope: Folder Participation, Create

 

URL Parameters

  • Param Name
    Type
    Description
  • SYNCPOINT_ID
    string
    ID associated with the target syncpoint. Positive value > 0. The method's requestor should be a syncpoint owner, syncpoint sharing participant or the company admin

Resource URL

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

Query Parameters


Name Values Description
modifier

Set the value to "no_email" to suppress sharing notification emails


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.

Content-Type
(required)

The Content-Type of the request

Body Parameters


Name Values Description
body
(required)

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

    User Not Authorized For Action
    Policy Prohibits Sharing

Working...