POST Usergroup

TABLE OF CONTENTS

Parameters
Example

Additional Info

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"

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	Array[String]	UserIds of the users you'd like to assign to this user group when created.
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 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

English

Parameters

Example