This API is used to delete device profile from customer's application profile (there may be more than one device for a customer that are using the application).
Cautionary Notice
[](This process is irreversible. Once a customer's device application profile is deleted, it cannot be recovered. However, customers can authenticate with the application and have it re-linked to their profile.)
This process is irreversible. Once a customer's device application profile is deleted, it cannot be recovered. However, customers can authenticate with the application using their customerid 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 / userid: Specifies the customer profile to which the device is associated. deviceid**: Specifies the device id 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.
https://api.imiconnect.io/resources/v2/customerappprofile/a_635736738702976937/9876/4451830998765
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.
Request Body
The following table describes the elements in the request body:
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| appid | String | Yes | IMIconnect generated Channel application ID. |
| customerid / userid | String | Yes | Specifies the customer profile to which the device is associated. |
| deviceid | String | Yes | Specifies the device id to be deleted. |
{
"response": {
"code": "1001",
"description": "Queued",
"transid": "3457ee77-53c8-52ac-8a51-ee6e062cae8a"
}
}
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 |