TABLE OF CONTENTS

  • Parameters
  • Example

 

ADDITIONAL INFO

  • API Explorer
  • General Information

 


This API allows you to update an existing user group.


This API is available via SSL-secured HTTPS connection on the Cloud using the REST PUT verb.
 The 
format query string parameter controls the desired response format. Specify either XML or JSON.
 

/api/v2/usergroup?format=xml/json


You may use either JSON or XML formats in your GET request.


 You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".


If no ContentType is specified, XML format is assumed. 


 

All XML formatted requests must specify the following XML namespace in the data source root element:

xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters

The PUT Usergroup API allows you to update an existing user group.


The required and optional parameters for a PUT submission to the Usergroup API are outlined below.


 

Name

Type

Description

Required

Id

String

The ID (GUID) of the user group you want to update.


 

Name
 

String

The name to assign to the user group when you update it.
 


 

ExternalId
 

String
 

ExternalId to assign when you update the user group.
 


 

UserIds
 

Array[String]

User IDs of the users you'd like to assign to this user group when updated.


 

CompanyId
 

Integer
 

Your unique Company ID is found on the Organization Setup page of the secure website.
 


 

IntegrationKey
 

String
 

Your unique Integration Key is found on the Organization Setup page of the secure website.
 


 

 

Example

Given that the API is REST-based, you can access the API directly via your web browser to test or by using the Postman API Platform.


The below example demonstrates how to update an existing user group using the PUT Usergroup API call.


Request URL

https://secure-amplusforms.com:443/api/v2/usergroup

 

Response Body

{

  "UserGroup": {

    "Id": "b42XXXXXXXXXXXXXXXXXXXXXXXXXXX",

    "Name": "The_Updated_UserGroup_Name",

    "ExternalId": "grp_the_updated_group_extid",

    "UserIds": [],

    "CompanyId": 6XXXX

  }

}

Response Code

200