## Overview You can create new groups using the API. ## Supported Versions Pleasanter 1.2.24.0 or later #### GroupMembers Plesanter 1.3.4.0 or later ## Preparation Please [Create an API Key](/manual/api-key) before performing API operations. Also, this function can only be performed by the tenant administrator, so please set up the tenant administrator from user management. ## Request Send json data in the following request format: |Setting item|Value| |:--|:--| |HTTP Method|POST| |Content-Type |application/json| |Character Code|UTF-8| |URL|http://{server name}/api/groups/create (*1)| |Body|Refer to the json data below| (*1) Please edit the {server name} part suit your environment as appropriate. For pleasanter.net, the format is as follows: https\://pleasanter.net/fs/api/groups/create ##### JSON ``` { "ApiVersion": 1.1, "ApiKey": "345yuAjA6789dA09d8uj6...", "GroupName": "[Name of group to register]", "Body": "Sample of group creation by API.", "GroupMembers": [ "User,1,True", "Dept,1,False" ], "GroupChildren": [ "Group,1," ] } ``` #### About GroupMembers Specify the information of users and organizations to add as group members in an array, separated by commas. |Column|Settings| |:--|:--| |Column 1|Specify 'User' to register a user or 'Dept' to register a department. | |Column 2|Specify the user/department ID. | |Column 3|Specify 'True' to grant administrator privileges, or 'False' to not grant administrator privileges. | #### About GroupChildren Specify the group information to be added to the child group in an array separated by commas. |Column|Settings| |:--|:--| |Column 1|Fixed to 'Group'. | |Column 2|Specify the group ID. | |Column 3|Fixed to blank. | ## Response The json data in the following format will be returned. ##### JSON ``` { "Id": 12345, "StatusCode": 200, "Message": "\"Name of group you want to register\" has been created." } ``` ## Confirmation Items in Case of Error [・Precautions when using the API and things to check if an error occurs](/manual/faq-api) [・FAQ: What to check if modified configuration files or API requests (JSON format) are not recognized correctly](/manual/faq-json-format) ## Specification Changes ***API specifications have been partially changed since October 2019.** - Classification, Numerical Value, Date, Description, and Check Items have been changed from being directly entered in the JSON to being entered within "～Hash". ***API specifications have been partially changed since November 2018.** - The URL format has been changed from '/pleasanter/api_items/xxxx' to '/pleasanter/api/items/xxxx'. - The Content-Type specification has been changed from 'application/x-www-form-urlencoded' to 'application/json'.