DELETE Api/Customer?customerToken={customerToken}&externalUserID={externalUserID}
Unenrolls an existing customer from the system.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
customerToken |
Contains the token that uniquely identifies this customer in the system. The customerToken value must be URL encoded. |
string |
Either customerToken OR externalUserID should be provided. Not both. |
externalUserID | string |
Either customerToken OR externalUserID should be provided. Not both. |
Body Parameters
None.
Response Information
Resource Description
Unenrolls an existing customer from the system.
BooleanResponseModelName | Description | Type | Additional information |
---|---|---|---|
ErrorCode |
Name of the error condition. See ErrorCode model for details. |
ErrorCode |
None. |
ErrorID |
Internal error identification number that uniquely identifies this specific error that occurred. |
string |
None. |
ErrorNum |
Numeric value of the ErrorCode |
int |
None. |
Errors |
List of errors that occurred when performing the requested operation. |
Collection of string |
None. |
Success |
Indicates sucess or failure of the REST request. |
boolean |
None. |
Response Formats
application/json, text/json
{ "ErrorCode": "None", "ErrorID": "sample string 1", "ErrorNum": 0, "Errors": [ "sample string 1", "sample string 2" ], "Success": true }