Remove a Contact Person
This webservice allows you to delete contact persons using an id or reference.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactDeletePerson | Required |
UserId | Int | The BigChange user contact Id (GUID). | Required |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | UserId parameter required | Mandatory parameter was not supplied |
2 | Invalid format UserId | Unrecognized GUID format value |
2 | UserId parameter is invalid | No record found using the specified parameters |
2 | misc_noRight | You do not have the permissions to create and update contacts. |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactDeletePerson&UserId=ace5e6ef-829f-4fb6-828b-672dbc83f82b
Response Data
{ "Code": 0, "Result": "Joe Bloggs has been deleted." }