delete https://api.imiconnect.io/resources/v2/customerappprofile/<appid>/<customerid>
This API is used to delete application profile of a customer.
Cautionary Notice
This process is irreversible. Once a customer application profile is deleted, it cannot be recovered. However, customers can authenticate with the application and have it re-linked to their profile.
Request
The delete app profile request is specified as follows:
| URL | https://api.imiconnect.io/resources/v2/customerappprofile// ** appid: Specifies the application id. customerid**: Specifies the customer profile to be deleted. |
| 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 Body
The following table describes the elements in the request body:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| appid | String | Yes | IMIconnect generated Channel application ID. |
| appprofilekey | String | Yes | Key for the profile. |
##Request Examples
https://api.imiconnect.io/resources/v2/customerappprofile/a_635736738702976937/9876
https://api.imiconnect.io/resources/v2/customerappprofile/a_635736738702976937?customerId=9876&customerId=9877
##Response Examples
{
"response": {
"code": "1001",
"description": "Queued",
"transid": "5157ee77-13c8-62ac-8a58-ee6e062cae8a"
}
}
{
"response": {
"code": "1001",
"description": "Queued",
"transid": "517ee77-53c8-42ac-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 |
| 7010 | Source IP is not whitelisted | Returned when a request is sent from an IP that is not whitelisted in IMIconnect. |
| 7014 | app profile not found | Click here |