| PATCH | /customers/{CustomerId}/address |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerId | path | string | Yes | The customer identifier |
| IsReturnToSender | body | bool | Yes | If true sets address status to ReturnToSender, otherwise sets address status Valid |
| RequestReference | body | RequestReference | No | Attribution values associated to the request if any |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CampaignId | form | string | No | |
| RetailChannelId | form | string | Yes | |
| ReferenceId | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /customers/{CustomerId}/address HTTP/1.1
Host: azs-stg-lotteries-web.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
customerId: String,
isReturnToSender: False,
requestReference:
{
campaignId: String,
retailChannelId: String,
referenceId: String
}
}