deleteGroup

Deletes a new group with the supplied id. You can only delete groups that were created by you.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
None. SRGroupAPI POST Yes.

Server API Syntax

https://secure2.convio.net/organization/site/SRGroupAPI?method=deleteGroup & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & group_id =value

Usage Notes

This method requires a Group ID and will delete a group in Luminate Online. You can only delete static groups which were created by the same API admin through the createGroup API.

Server API callers must have "Group Management/Use Luminate Online Groups API" permission.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

group_id

Required. The id of the group you would like to delete.

Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<xml-fragment xmlns:ns2="http://convio.com/crm/v1.0"/>
JSON response 
{"xml-fragment":{"xmlns:ns2":"http://convio.com/crm/v1.0"}}
Parent topic: Group API
Previous topic: createGroup
Next topic: getGroupInfo

Leave a Comment

Nickname
Comment
Enter this word:
Change