TABLE OF CONTENTS

  • Parameters
  • Example


ADDITIONAL INFO

  • API Explorer
  • General Information



This API allows you to delete an existing user group.


On the Cloud, this API is available via SSL-secured HTTPS connection using the REST DELETE 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 DELETE 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 DELETE Usergroup API allows you to delete an existing user group by specifying that group's Id (GUID).


 The required and optional parameters for a DELETE 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.
 

✓
 

CompanyId
 

Integer

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

✓
 

IntegrationKey
 

String
 

Your unique Integration Key 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 delete an existing user group using the DELETE Usergroup API call.

 

Request URL

https://secure.amplusforms.com:443/api/v2/usergroup?Id=b42XXXXXXXXXXXXXXXXXXXXXXXXXXX&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body

{}

Response Code

200