UpdateClientEmailAddress

Usage

Allows you to update a customer’s email address.

If an account has guarantor details then the guarantor contact information (phone number and email address) will always be the preferred contact for the account.

Parameters

Name	Data Type	Length		Description
DateCreated				Date/time message was processed
User
Id				Unique ID for the user
Username	String		Required	Provided by Debitsuccess
Password	String		Required	Provided by Debitsuccess
RequestInitiator	String	100	Optional	Allows requesting user to be logged
AccountReferenceNo	String	15	Optional^*	Debitsuccess account reference
ExternalAccountReferenceNo	String	50	Optional^*	External account reference
EmailAddress	Email		Required
Id
Preferred	Boolean
EmailAddress	String	75

_{* At least one of the following parameters must be supplied: AccountReferenceNo, ExternalAccountReferenceNo}

Response

Name	Data Type	Description
DateCreated	DateTime	Date/time message was processed
Id	String	Unique ID for the message
ResponseNotes ()		Collection of validation messages
Code	String
Note	String
NoteType	Enum	Error, Warning, Info
Status	Enum	Failed, Succeed, Unknown

Error Message

Type	Error Code	Error Message
Error	02	Invalid user credentials
Error	12016	Missing required reference number. Must provide either ExternalAccountReferenceNo or AccountReferenceNo or both.
Error	08	There is no record found with this criteria
Error	10	Account is not active
Error	07	Multiple accounts found with this criteria
Info	00	Success
Warning	14030	Preferred is set to FALSE as customers with Guarantor’s email address are not allowed to update other email address to Preferred

Related Pages

Page:

Update customer's information

On this page:

REST API

PUT Email Address