delete https://api.imiconnect.io/resources/v2/customerprofile/<customerid>
This API is used to delete a customer profile.
Cautionary Notice
This process is irreversible. Once a customer profile is deleted, it cannot be recovered. However, a new customer profile can be created with the same customer id.
Request
The delete profile request is specified as follows:
| URL | https://api.imiconnect.io/resources/v2/customerprofile/ ** customerid**: A client specific ID (such as CRN) to uniquely identify a customer. |
| Method | DELETE |
Request Headers
The following table describes the request headers:
| Request Header | Description |
|---|---|
| key | Client profile key |
| content-type | application/json |
For data privacy and security reasons, the REST API is served over encrypted HTTPS. Standard HTTP is not supported.
##Request Examples
https://api.imiconnect.io/resources/v1/customerprofile/1234
https://api.imiconnect.io/resources/v1/customerprofile?customerId=1234&customerId=1235
##Response Examples
{
"response": {
"code": "1001",
"description": "Queued",
"transid": "5198ee77-51c8-42ac-5a58-ee6e062cae8a"
}
}
{
"response": {
"code": "1001",
"description": "Queued",
"transid": "5257ee77-53c8-12ac-8a58-ee6e062cae8a"
}
}
To know the status of the request
Use transid from the response and make a Get Profile status API call to get status of the request.
Response Codes
Following are the response codes this method may return:
| Response Code | Message | Description |
|---|---|---|
| 1000 | Queued | Returned when the request is queued. |
| 7001 | Authentication failed | Returned when an invalid service key or profile key is provided in the request. |
| 7002 | Service Key Missing | Returned when the parameter key is missing in the message request. |
| 7003 | Mandatory parameters missing | Click here |
| 7203 | Customer not found | Click here |
| 7208 | Source IP is not whitelisted | Returned when a request is sent from an IP that is not whitelisted in IMIconnect. |