Remove a Contact Group
Remove contact groups utilizing either the Contact Group Id or Contact Group Name.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactGroupDelete | Required |
ContactGroupId | Int | The unique identifier of the contact note group which can be retrieved using Contact Groups | Required |
ContactGroupName | String(50) | The name of the contact group. Must be supplied if ContactGroupId value isn’t available. | Required |
Response Codes
Code | Message | Information |
---|---|---|
0 | Contract Group Deleted | |
2 | ContactGroupId or contactGroupName parameters required | Mandatory parameter was not supplied |
2 | Contact Group not found with Contract Group Id = {contactGroupId} | No data returned or set-up in BigChange |
2 | Contact Group not found with Contract Group Name = {contactGroupName} | No data returned or set-up in BigChange |
2 | Contact group not deleted successfully | The contact group as not deleted |
2 | You can't delete this group while it has contacts in it | Ensure all contacts in the group have been removed |
2 | misc_noRight | You do not have the permissions to setting for Contacts. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactGroupDelete&ContactGroupId=130087
Response Data
{ "Code": 0, "Result": "Contract Group Deleted" }