Skip to content

Delete Group

Overview

You can delete records using the API.

Supported Versions

Pleasanter 1.2.24.0 or later

Preparations

Please Create an API Key before performing API operations. Also, this function can only be performed by the tenant manager, so please set up the tenant manager from user management.

Request

Send json data in the following request format:

Setting column Value
HTTP Method POST
Content-Type application/json
Character Code UTF-8
URL http://{server name}/api/groups/{group ID}/delete (*1)
Body Refer to the json data below

(*1) Please edit the {server name} and {group ID} parts suit your environment as appropriate.
For Pleasanter.net, the format is as follows:
https://pleasanter.net/fs/api/groups/{group ID}/delete

JSON
{
    "ApiVersion": 1.1,
    "ApiKey": "l3ghls083sasA62Ssa32..."
}

Response

The json data in the following format will be returned.

JSON
{
    "Id": 12345,
    "StatusCode": 200,
    "Message": "Deleted \"The specified group name\"."
}

Confirmation Column in Case of Error

・Precautions when using the API and things to check if an error occurs
・FAQ: What to check if modified configuration files or API requests (JSON format) are not recognized correctly

Specification Changes

*API specifications have been partially changed since October 2019.**
- Classification, Numerical Value, Date, Description, and Check Column 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'.