PUT api/Customer/SaveCustomer

Allows a customer to be updated or created by passing an APICustomer within the body. Pass in an ID of 0 to create a new customer

Request Information

URI Parameters

None.

Body Parameters

The APICustomer object to be updated or created as a customer

APICustomer
NameDescriptionTypeAdditional information
ID

integer

None.
Email

string

None.
UDF

string

None.
Title

string

None.
Firstname

string

None.
Middlename

string

None.
Lastname

string

None.
DOB

date

None.
CompanyName

string

None.
HouseNo

string

None.
AddressLine1

string

None.
AddressLine2

string

None.
AddressLine3

string

None.
City

string

None.
Postcode

string

None.
County

string

None.
Country

string

None.
TelephoneNumber

string

None.
EveningTelephoneNumber

string

None.
MailingList

string

None.
Notes

string

None.
Password

string

None.
Interests

Collection of Object

None.
PersonImage

string

None.
DDAcountHolder

string

None.
DDAccountNumber

string

None.
DDSortCode

string

None.
DDBankName

string

None.
DDBankAddress

string

None.
DDBankPostCode

string

None.
MemberNumber

string

None.
AccountRef

string

None.
ConsentMail

boolean

None.
ConsentPhone

boolean

None.
ConsentSMS

boolean

None.
ConsentEmail

boolean

None.
Username

string

None.
ForcePasswordChange

boolean

None.
CustomerRef

string

None.
CustomerUDFs

Collection of Object

None.

Request Formats

application/json, text/json

Sample: 
{"ID":0,"Email":"","UDF":"","Title":"","Firstname":"","Middlename":"","Lastname":"","DOB":"0001-01-01T00:00:00","CompanyName":"","HouseNo":"","AddressLine1":"","AddressLine2":"","AddressLine3":"","City":"","Postcode":"","County":"","Country":"","TelephoneNumber":"","EveningTelephoneNumber":"","MailingList":"","Notes":"","Password":"","Interests":[{"ID":1,"Description":"Events"}],"PersonImage":"","DDAcountHolder":"","DDAccountNumber":"","DDSortCode":"","DDBankName":"","DDBankAddress":"","DDBankPostCode":"","MemberNumber":"","AccountRef":"","ConsentMail":false,"ConsentPhone":false,"ConsentSMS":false,"ConsentEmail":false,"Username":"","ForcePasswordChange":false,"CustomerRef":"","CustomerUDFs":[{"UDFID":1,"UDFDescription":"Car Reg","UDFValue":"AB1 23C","UDFDataType":"Text"}]}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<Customer xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>0</ID>
  <Email />
  <UDF />
  <Title />
  <Firstname />
  <Middlename />
  <Lastname />
  <DOB>0001-01-01T00:00:00</DOB>
  <CompanyName />
  <HouseNo />
  <AddressLine1 />
  <AddressLine2 />
  <AddressLine3 />
  <City />
  <Postcode />
  <County />
  <Country />
  <TelephoneNumber />
  <EveningTelephoneNumber />
  <MailingList />
  <Notes />
  <Password />
  <Interests>
    <APICustomerInterest>
      <ID>1</ID>
      <Description>Events</Description>
    </APICustomerInterest>
  </Interests>
  <PersonImage />
  <DDAcountHolder />
  <DDAccountNumber />
  <DDSortCode />
  <DDBankName />
  <DDBankAddress />
  <DDBankPostCode />
  <MemberNumber />
  <AccountRef />
  <ConsentMail>false</ConsentMail>
  <ConsentPhone>false</ConsentPhone>
  <ConsentSMS>false</ConsentSMS>
  <ConsentEmail>false</ConsentEmail>
  <Username />
  <ForcePasswordChange>false</ForcePasswordChange>
  <CustomerRef />
  <CustomerUDFs>
    <APICustomerUDF>
      <UDFID>1</UDFID>
      <UDFDescription>Car Reg</UDFDescription>
      <UDFValue>AB1 23C</UDFValue>
      <UDFDataType>Text</UDFDataType>
    </APICustomerUDF>
  </CustomerUDFs>
</Customer>

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample: 
{"Result":"SUCCESS","Message":"The Customer has been saved/updated with the following ID: 001"}

application/xml, text/xml

Sample: 
<?xml version="1.0" encoding="utf-16"?>
<InformationResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Result>SUCCESS</Result>
  <Message>The Customer has been saved/updated with the following ID: 001</Message>
</InformationResponse>