| PATCH | /customers/{CustomerId} |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | path | string | Yes | The customer identifier |
| KnownAs | query | string | No | The name the customer is known as |
| RemoveKnownAs | query | bool? | No | When true, known as will be removed |
| Title | query | PersonTitle? | No | Person titleAllowable Values
|
| FirstName | query | string | No | First name |
| LastName | query | string | No | Last name |
| DateOfBirth | query | DateTime? | No | Date of birth. format YYYY-MM-DD |
| MobilePhone | query | string | No | Mobile phone |
| RemoveMobilePhone | query | bool? | No | When true, mobile phone will be removed |
| HomePhone | query | string | No | Home phone |
| RemoveHomePhone | query | bool? | No | When true, mobile phone will be removed |
| Address | query | Address | No | Postal address |
| NotForPublication | query | bool? | No | True to remain confidential if declared a winner. Default is false |
| SendTicketsViaPost | query | bool? | No | True to mail tickets to the postal address. Default is false |
| RequestReference | query | RequestReference | No | Attribution values associated to the request if any |
| AccountInstructions | query | string | No | Additional information / notes about customer. e.g. when calling, Speak Loud for this customer |
| RemoveAccountInstructions | query | bool? | No | When true, the account instructions will be deleted |
| IdentityStatus | query | IdentityStatus? | No | The identity status of customer in Dynamics |
| Mr |
| Mrs |
| Miss |
| Ms |
| Dr |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Street | form | string | No | |
| City | form | string | No | |
| ZipCode | form | string | No | |
| State | form | string | No | |
| CountryRegionId | form | string | No | |
| DPID | form | int | No | |
| Suburb | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | form | string | No | |
| RetailChannelId | form | string | Yes | |
| ReferenceId | form | string | No |
| Name | Value |
|---|---|
| NewCustomer | 0 |
| NoOnlineAccount | 1 |
| ValidOnlineAccount | 2 |
| PrimaryEmailChange | 3 |
| EmailAlreadyInIM | 4 |
| PrimaryEmailRemoved | 5 |
| Unknown | -1 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /customers/{CustomerId} HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"customerId":"String","knownAs":"String","removeKnownAs":false,"title":"Mr","firstName":"String","lastName":"String","dateOfBirth":"0001-01-01T00:00:00.0000000","mobilePhone":"String","removeMobilePhone":false,"homePhone":"String","removeHomePhone":false,"address":{"street":"String","city":"String","zipCode":"String","state":"String","countryRegionId":"String","dpid":0,"suburb":"String"},"notForPublication":false,"sendTicketsViaPost":false,"requestReference":{"campaignId":"String","retailChannelId":"String","referenceId":"String"},"accountInstructions":"String","removeAccountInstructions":false,"identityStatus":"NewCustomer"}