API Delete User Group

This API call will delete an existing user group.

Resource URL

http://valt.example.com/api/v3/admin/user_groups/{groupid}/delete

Replace {groupid} with the actual id number of the group. Groups are numbered sequentially when added to VALT.

Resource Information

Method	POST
Response Type	JSON
Authentication Required	No

Parameters

No parameters are required for this API call.

Response

Code	Reason
200	Request Successful
401	Unauthorized
404	User Group Not Found

JSON Response

data
message	Deleted

Examples

Request

The sample JSON body below is formatted with line breaks and indentation to make it easier to read. This is not required.

https://ivstest1.ad.ipivs.com/api/v3/admin/user_groups/888/delete?access_token=exampletoken

Successful Response

{
"data":{
"message": "Deleted"
}
}

Failure Response

{
"error":{
"code": 404
}
}