Update a Contact Group
This web service allows you to update contact groups by adding contacts to the group or adding custom fields.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactGroupUpdate | Required |
ContactId | Int | The unique identifier of the contact which can be retrieved using Contact List. | Required |
ContactRef | String | The internal reference of the contact. | Required |
ContactGroup | String | Contact group must already exist. | Required |
CopyCustomFields | Bool | 0=false or 1=true | Optional |
Response Codes
Code | Message | Information |
---|---|---|
0 | Response Data | See 'Response' example tab |
2 | contactId or contactRef parameters required | Mandatory parameter was not supplied |
2 | Missing parameter - contactGroup | Mandatory parameter was not supplied |
2 | No matching contact group exists | No data returned or set-up in BigChange |
2 | Invalid parameter - contactId | Integer value is invalid or was not specified (when required) |
2 | No matching contact | No data returned or set-up in BigChange |
2 | Error Multiple Contacts with Reference {contactRef} | The service could not determine which contact to remove due to duplicates. Please use the ContactId |
2 | Contact already a member of target group {contactGroup.ContactGroupId} | Contact is already in the target group and therefore has not been moved |
2 | Contact Group Update Failed {error} | Please contact Support providing the parameters used and the error message returned |
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactGroupUpdate&ContactId=30966833&ContactGroup=Customers
Response Data
{ "Code": 0, "Result": { "ContactId": 30966833, "ContactGroupId": 20438, "ContactName": "Joe Bloggs", "ContactStreet": "4351 Somewhere Close", "ContactPostCode": "AB12 3CD", "ContactTown": "Anywhere", "ContactCountry": "United Kingdom", "ContactPerson": "", "ContactFlagged": false, "ContactCenter": { "Latitude": 59.38943, "Longitude": -3.74243 }, "ContactOwnerId": 25193, "ContactOnStop": 1, "UpdateNow": false } }