group.delete

Delete a group

Warning! This will remove the group and all its associated results.

Request Parameters

group_idint (required)

Id for the group you want to delete.

Response Parameters

successboolean
Returns True if it was deleted successfully.

Code Examples

JSON

//Request
{
  "method":"group.delete",
  "params":{
    "group_id":607
  },
  "id":0
}
  
//Response
{
 "id":0,
 "result":{
    "success": true
  }
}

Java

// You need to have a ready-to-use client to use the other methods
SaploClient client = new SaploClient("YOUR_API_KEY", "YOUR_SECRET_KEY");

// Create a SaploGroupManager to work with groups
SaploGroupManager groupMgr = new SaploGroupManager(client);

// Assuming you know the ID of the group you want to delete
SaploGroup group = new SaploGroup();
group.setId(groupId);

// Delete the group from the API
groupMgr.delete(group);

Python

client = SaploJSONClient("YOUR API KEY", "YOUR SECRET KEY")
 
deleted_group = client.group.delete(
            group_id=678
            )
 
print "Successfully deleted group."

Matlab

params.group_id = 415;
 
response = saploRequest('group.delete', params)