Add or Update a Contact

Add or edit a contact within BigChange

Query String Parameters

Name	Type	Description	Required
Action	String	ContactSave	Required
ContactName	String(50)	The name of the contact.	Required
ContactGroup	String(50)	The unique identifier of the contact note group which can be retrieved using Contact Groups - must be provided if also supplying CustomFields The contact group will be created if it does not exist. Will default to "Imported Contacts" of not provided	Optional
ContactParentReference	String(40)	The internal reference of the parent contact.	Optional
ContactParentId	Int	The unique identifier of the parent contact which can be retrieved using Contact List.	Optional
ContactReference	String(40)	The internal reference of the contact.	Optional
ContactId	Int	The unique identifier of the contact which can be retrieved using Contact List.	Optional
ContactStreet	String(100)	The street address of the contact. Required unless using ContactLat and ContactLng	Optional
ContactPostcode	String(10)	The postal code of the contact.	Optional
ContactTown	String(100)	The address town of the contact.	Optional
ContactCountry	String(50)	The address country of the contact. Country	Optional
ContactLat	Double	The geolocation latitude of the contact. Required if ContactStreet is not provided	Optional
ContactLng	Double	The geolocation longitude of the contact. Required if ContactStreet is not provided	Optional
ContactRadiusMeter	Int	Radius of circular geofence in meters.	Optional
ContactPerson	String(30)	The primary person of the contact.	Optional
ContactPhone	String(30)	The phone number of the primary person of the contact. Phone numbers must be encoded and in International format with no spaces. ie: %2B447954012012	Optional
ContactEmail	String(100)	Email address for the primary person of the contact.	Optional
ContactExtra	String(255)	Free format text information about the Contact.	Optional
ContactReplaceSameRef	Int	Existing contact with same reference will be replaced Default 0.	Optional
ContactFirstName	String	First name of the contact.	Optional
ContactLastName	String	Last name of the contact.	Optional
ContactAccountReference	String	The financial account reference.	Optional
ContactAccountType	Int	Account type.	Optional
ContactExtraUpdate	Int	Update contact’s extra info.	Optional
CreditLimit	String	Contact’s credit limit.	Optional
CreditLimitCurrency	String	Currency of the credit limit.	Optional
ContactExtraDelay2Pay	String	An extra parameter for Delay2Pay.	Optional
ContactOnStop	Int	On Stop status.	Optional
ContactOnStopDescendant	Bool	Must be set to true to apply 'On Stop' to child contacts.	Optional
ContactOnStopReason	String	Free format field to explain reason contact is on stop	Optional
ContactWhat3Words	String	Set location using What3Words. Will over-write any polygon data, and replace with a radius (default or supplied).	Optional
ContactPolygonUpdate	Bool	Set to true updates the polygon based on lat/lng coordinates.	Optional
cust_custom field name	String	Pass cust_ followed by the caption of an existing custom field.	Optional

Response Codes

Code	Message	Information
0	Response Data	See 'Response' example tab
2	Contact Radius is not a valid number	Integer value is invalid or was not specified (when required)
2	Invalid Credit Limit	Double value is invalid or was not specified (when required)
2	Invalid Delay2Pay	Short value is invalid or was not specified (when required)
2	contactOnStopType - must be integer value 0 = None , 1 = OnStop , 2 = Credit Limit On Stop	Unrecognized constant value - please verify the supported values
2	The specified contact group does not exist and cannot be created with the details passed	An error occurred when attempting to save the Contact Group. Contact Support if this continues.
2	Invalid parameter ContactWhat3Words	Check the format of the What3Words string and that the names are correct

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=ContactSave&contactname=Lucy+Margetts&contactgroup=Customer&contactreference=IH-04&contactstreet=23+Maple+Avenue&contacttown=Leicester&contactpostcode=LE47QP&contactphone=%2B447932883112&contactemail=lucymargetts%40outlook.com

Response

Response Data

{
  "Code": 0,
  "Result": 38759340
}