API Documentation
Group PUT

put

Group PUT

Updates the name, owner or other attributes of the user group.
Note: Only administrators can invoke this API.
Required Scope: Groups, Update

 

URL Parameters

  • Param Name
    Type
    Description
  • GROUP_GUID
    string
    Unique ID associated with the group

Resource URL

https://api.syncplicity.com/ provisioning/group.svc/{GROUP_GUID}

Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Content-Type
(required)

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

    (Not Modified) - No update was made to the Syncplicity Product

  • 400
    400

    (Bad Request) - Company not updateable: If the Company property is included, this error is returned
    (Bad Request) - Invalid Company Argument: Invalid Company Argument
    (Bad Request) - Missing Company Owner Argument
    (Bad Request) - Invalid Values in Input
    (Bad Request) - Invalid Account Type
    (Bad Request) - Member not updateable
    (Bad Request) - Group Must be Set: Request body must contain Group element
    (Bad Request) - Illegal HTML in name: Group name contains illegal characters
    (Bad Request) - Owner email address must be set and valid: If the Owner property is set, owner email address must be set and valid
    (Bad Request) - Unknown group owner email address: Group owner must have an existing user account
    (Bad Request) - Only Company Users Allowed: Group owner must be a member of the group's company (Business)

  • 403
    403

    (Forbidden) - Not A Business Admin: The current user is not a company administrator for the specified group
    (Forbidden) - Not This Company Group: Requester must be a member of the group's company

  • 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) - Company Not Found

  • 409
    409

    (Conflict) - Name already exists: Group with the same name already exists in the company

Working...