Remove a Contact
Remove contacts using the Contact Id or Contact Name.
info
The contact will not be physically deleted from BigChange as it may still be referenced by other entities. It is instead no longer available from the web portal or to the web services and only available where included in an items history.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactDelete | Required |
ContactId | Int | The unique identifier of the contact which can be retrieved using Contact List. | Optional |
ContactRef | String(50) | The internal reference of the contact. | Optional |
tip
The Contact Reference or Id can be supplied. If both parameters are provided, the Contact Id will take precedence.
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | contactId or contactRef parameters required | Mandatory parameter was not supplied |
2 | Invalid Format - ContactId | Integer value is invalid or was not specified (when required) |
2 | No matching contact | No data returned or set-up in BigChange |
2 | misc_noRight | You do not have the permissions to delete contacts. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactDelete&ContactId=21635423
Response Data
{ "Code": 0 }