API Documentation
Group member DELETE

delete

Group member DELETE

Remove the specified user from the group. The application must be running as a user that has administrator rights to perform the delete action.
Required Scope: Group Members, Delete

 

URL Parameters

  • Param Name
    Type
    Description
  • GROUP_GUID
    string
    The ID of the group to be deleted
  • USER_EMAIL
    string
    Email address of the group member who should be deleted. The email address must be registered with Syncplicity and associated with the user group

Resource URL

https://api.syncplicity.com/ provisioning/group_member.svc/{GROUP_GUID}/member/{USER_EMAIL}

Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

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) - Only Company Users Allowed
    (Bad Request) - Member Email Address Must Be Set And Valid

  • 403
    403

    (Forbidden) - Not A Business Admin: The user attempting to execute this request is not a company administrator
    (Forbidden) - Not This Company Group: Requester must be a member of the group's company
    (Forbidden) - Request Came From Unapproved IP Address
    (Forbidden) - User Not Authorized For Action

  • 404
    404

    (Not Found) - Unknown Group ID: A group with the provided ID (Guid) does not exist in Syncplicity
    (Not Found) - Wrong Group ID: Group ID must be a Guid
    (Not Found) - Not This Group Member
    (Not Found) - Unknown User Email

Working...