POST api/PurgeCustomer
Request Information
URI Parameters
None.
Body Parameters
CustomerPurge| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerNumber | string |
None. |
|
| MarkCustomerInactive | boolean |
None. |
|
| PurgeFromDataStore | boolean |
None. |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| TicketNumber | globally unique identifier |
None. |
|
| RequestedBy | string |
None. |
|
| RequestedFrom | string |
None. |
|
| RequestedDate | date |
None. |
|
| ExecutedDate | date |
None. |
|
| ExecutedBy | string |
None. |
|
| ErrorInfo | string |
None. |
|
| Status | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CustomerNumber": "sample string 1",
"MarkCustomerInactive": true,
"PurgeFromDataStore": true,
"StartDate": "2026-02-14T03:06:14.9346593+00:00",
"EndDate": "2026-02-14T03:06:14.9346593+00:00",
"TicketNumber": "0a0df508-9257-403b-9458-db158c473929",
"RequestedBy": "sample string 7",
"RequestedFrom": "sample string 8",
"RequestedDate": "2026-02-14T03:06:14.9346593+00:00",
"ExecutedDate": "2026-02-14T03:06:14.9346593+00:00",
"ExecutedBy": "sample string 11",
"ErrorInfo": "sample string 12",
"Status": "sample string 13"
}
application/xml, text/xml
Sample:
<CustomerPurge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScheduledJobModels"> <CustomerNumber>sample string 1</CustomerNumber> <EndDate>2026-02-14T03:06:14.9346593+00:00</EndDate> <ErrorInfo>sample string 12</ErrorInfo> <ExecutedBy>sample string 11</ExecutedBy> <ExecutedDate>2026-02-14T03:06:14.9346593+00:00</ExecutedDate> <MarkCustomerInactive>true</MarkCustomerInactive> <PurgeFromDataStore>true</PurgeFromDataStore> <RequestedBy>sample string 7</RequestedBy> <RequestedDate>2026-02-14T03:06:14.9346593+00:00</RequestedDate> <RequestedFrom>sample string 8</RequestedFrom> <StartDate>2026-02-14T03:06:14.9346593+00:00</StartDate> <Status>sample string 13</Status> <TicketNumber>0a0df508-9257-403b-9458-db158c473929</TicketNumber> </CustomerPurge>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.