DELETE Usergroup

DELETE Usergroup

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”

Endpoints & API Explorer

NodeAPI EndpointAPI Explorer
USapi/v2/usergroupModel Description/Schema & Parameters

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.

NameTypeDescriptionRequired
IdStringThe Id (GUID) of the user group you want to update.
✓
CompanyId
IntegerYour unique Company Id found on the Organisation Setup page of the secure website.
✓
IntegrationKey
String
Your unique Integration Key found on the Organisation 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 Postman API Platform.

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

Request URL

https://eforms.mobileform.net/api/v2/usergroup?Id=b42XXXXXXXXXXXXXXXXXXXXXXXXXXX&CompanyId=6XXXX&IntegrationKey=995XXXXXXXXXXXXXXXXXXXXXXXXXXXX

Response Body

{}

Response Code

200

    • Related Articles

    • PUT Usergroup

      This API allows you to update an existing user group. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST PUT verb. The format query string parameter controls the desired response format. Specify either XML or JSON. ...

    • POST Usergroup

      This API allows you to create a new user group. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST POST verb. The format query string parameter controls the desired response format. Specify either XML or JSON. ...

    • GET Usergroup

      This API returns details of the user group matching the given parameters. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response format. Specify ...

    • GET Usergroup (Search)

      This API allows you to find all user groups matching the given parameters. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response format. Specify ...

    • DELETE Screen

      The DELETE Screen Form API allows you to delete an existing form screen. This allows you to delete specific screens from the platform as required, from various 3rd party systems, for whatever reason. On the Cloud, this API is available via ...