/updatecustomer

V1.0

Description

Updates the details for a registered contact in iCasework.

You must pass a value for Id.

Request Method

POST

API Service endpoints

UAT: https://uat.icasework.com/updatecustomer?db=[youriCaseworkAccount]
eUAT / Production system: https://[youriCaseworkAccount].icasework.com/updatecustomer

Your iCasework account name will be supplied to you by your iCasework Account or Project Manager

Request Parameters

Parameter	Description	Example Input	Required value?

Parameter	Description	Example Input	Required value?
Id	The registered contact reference of the customer to be updated.	"12317985"	Yes.
NewId	Give a new iCasework registered contact reference for the customer	"1283821"	No.
AlternativeId1	Give a new first alternate Id for the customer. Please contact your iCasework representative to understand what this represents in your system.	"12793179"	No.
AlternativeId2	Give a new second alternate Id for the customer. Please contact your iCasework representative to understand what this represents in your system.	"12793179"	No.
TwitterUsername	The customer's twitter username, used for twitter integration	"thomasethorpe"	No.
Title	The customer's title	"Mr"	No.
FirstName	The customer's forename	"John"	No.
Surname	The customer's surname	"Smith"	No.
Organisation	The company to which this customer belongs	"iCasework"	No.
Address	The customer's address	"30 Stamford Street"	No.
Town/City	The town/city in which the customer resides. Either Town or City can be used to update this field.	"London"	No.
County/State	The regional subdivision in which the customer resides. Either County or State can be used to update this field	"London"	No.
Country	The country in which the customer resides	"United Kingdom"	No.
Postcode/ZIPCode	The postal identifier for the aforementioned address. Either Postcode or ZIPCode can be used to update this field	"SE1 9LQ"	No.
Email	The customer's email address.	"test@example.com"	No.
Phone	The customer's landline number	"01132162959"	No.
Mobile	The customer's mobile number	"07728482772"	No.
EveningPhone	An alternative contact number for use in the evening	"07728482772"	No.
WeekendPhone	An alternative contact number for use at weekends	"07728482772"	No.
Fax	The customer's fax number	"01132162959"	No.
ContactMethod	The customer's preferred contact method.	"Email"	No.
ContactTime	The customer's preferred contact time.	"Morning"	No.
ContactLanguage	The customer's preferred contact language.	"English"	No.
ContactConsent	Defines whether the customer consents to be contacted	"true"	No.
DisplayLabel	A label which is returned when fetching a list of customers		No.
Category	A categorisation for the customer	"Private individual"	No.
Gender	The customer's gender	"Male"	No.
EthnicOrigin	The customer's ethnicity	"White British"	No.
DateOfBirth	The customer's date of birth	"1994-01-14"	No.
DeceasedDate	The customer's date of death	"2021-01-16"	No.
AgeGroup	The customer's age category	"Over 60"	No.
Sexuality	The customers sexuality	"Heterosexual"	No.
Faith	The customer's faith	"Christian"	No.
Disability1 - Disability9	Various fields to record disabilities		No.
Custom1 - Custom25	Custom fields to take additional customer information. Your iCasework representative can inform you of what these represent for your particular configuration		No.
Format	Format of the response. Can be either JSON or XML. Default is XML.	“json”	No.

Example

Request

<https://example.icasework.com/updatecustomer>

{
 "Id": "3215421",
 "Address": "30 Stamford Street"
 "Format": "json"
}

<?xml version="1.0" encoding="UTF-8" ?>
<Id>3215421</Id>
<Address>30 Stamford Street</Address>

Response

<?xml version="1.0" encoding="UTF-8"?> 
  <updatecustomerresponse>
    <customerid>1612616</customerid>
  </updatecustomerresponse>

{
  "updatecustomerresponse": {
    "customerid": "16165154215"
  }
}

HTTP 400 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
3000	Invalid HTTP method	Check the HTTP method of the request; this should be a POST
3001	API not available here	Check the endpoint of the request
3002	Required parameter Id was not supplied.	Pass a value for `Id` .
3051	Unable to identify customer	Check that the value passed for `Id` is a valid customer reference

HTTP 403 responses

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips

X-Application-Error-Code	X-Application-Error-Info	Troubleshooting tips
3021	Incorrect key or signature	Check the authentication method of the request
3021	Invalid token (6)	Check the authentication method of the request
3022	Insufficient privileges to update customer details	Check that there is a user associated with the API key

updatecustomer