7/15/24, 5:35 PM

DELETE Usergroup
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"

1/8
 7/15/24, 5:35 PM

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. ✓
Your unique Company Id found on the Organisation Setup page of
CompanyId Integer ✓
the secure website.
Your unique Integration Key found on the Organisation Setup page
IntegrationKey String ✓
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.formsonfire.com:443/api/v2/usergroup?Id=b42XXXXXXXXXXXXXXXXXXXXXXXX

Response Body
{}

Response Code
200

2/8
 7/15/24, 5:35 PM

PUT Usergroup
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.
User IDs of the users you'd like to assign to this user group when
UserIds Array[String]
updated.
Your unique Company ID is found on the Organization Setup page of
CompanyId Integer ✓
the secure website.
Your unique Integration Key is found on the Organization Setup page
IntegrationKey String ✓
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.

3/8
 7/15/24, 5:35 PM

The below example demonstrates how to update an existing user group using the PUT Usergroup API call.
Request URL
https://secure-formsonfire..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

4/8
 7/15/24, 5:35 PM

POST Usergroup
TABLE OF CONTENTS
Parameters
Example
Additional Info
API Explorer
General Information

This API allows you to create a new user group.

This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST 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"

5/8
 7/15/24, 5:35 PM

Parameters
The POST Usergroup API allows you to create a new user group.
The required and optional parameters for a POST submission to the Usergroup API are outlined below.

Name Type Description Required

Name String The name of the user group you'd like to create. ✓
ExternalId String ExternalId title of the new user group you will create.
UserIds of the users you'd like to assign to this user group when
UserIds Array[String]
created.

Your unique Company ID is found on the Organization Setup page

CompanyId Integer ✓
of the secure website.
Your unique Integration Key is found on the Organization Setup
IntegrationKey String ✓
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 create a new user group using the POST Usergroup API call.

Request URL
https://secure.formsonfire.com:443/api/v2/usergroup

Response Body
{
"UserGroup": {
"Id": "d50XXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Another_Test_Group",
"ExternalId": "grp_test2",
"UserIds": [],
"CompanyId": 6XXXX
}
}

Response Code
200

6/8
 7/15/24, 5:35 PM

GET Usergroup (Search)

TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

This API allows you to find all user groups matching the given parameters.

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

/api/v2/usergroup/search?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"

7/8
 7/15/24, 5:35 PM

Parameters
The GET Usergroup (Search) API allows you to find all user groups that match given parameters.
The required and optional parameters for a GET call to the Usergroup (Search) API are outlined below.

Name Type Description Required

Name String User Group name to search for.
ExternalId String User Group external ID to search for.
PageNo Integer The page number from which to start reading results (0 based).

The page size (number of rows) to return. The maximum allowable value
PageSize Integer
is 250.
Your unique Company ID is found on the Organization Setup page of the
CompanyId Integer ✓
secure website.
Your unique Integration Key is found on the Organization Setup page of
IntegrationKey String ✓
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 find user groups using the GET Usergroup API call.

Request URL
https://secure.formsonfire.com:443/api/v2/usergroup/search?CompanyId=6XXXX&Integra

Response Body
{
"UserGroups": [
{
"Id": "b42XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"Name": "Testgroup",
"UserIds": [
"c9bXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
],
"CompanyId": 6XXXX
}
],
"TotalRows": 1
}

8/8