delete https://api.instantpay.in/contacts/note
Use Instantpay's Delete Note API to maintain a focused, organised dataset. It's a must-have tool for businesses that want to optimise data management. This API lets you remove outdated notes. It keeps your info focused on the most relevant details.
The Delete Note API is ideal for organisations with dynamic datasets. It simplifies deleting unnecessary notes. This supports a more effective data strategy. This solution will help businesses manage their data. It will retain only the valuable information that supports better decision-making.
Request Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| gcId | String | Mandatory | Contact Id(You will get from Add Contact Response) |
| noteId | String | Mandatory | Note Unique Id |
Sample Request
curl --location --request DELETE 'https://api.instantpay.in/contacts/note' \
--header 'XContent-Type: application/json' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--header 'Content-Type: application/json' \
--data '{
"gcId":"645383ba4acec95a32089822",
"noteId" : "6453992d54c74877510e5372"
}'
DELETE /contacts/note HTTP/1.1
Host: api.instantpay.in
XContent-Type: application/json
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Type: application/json
Content-Length: 84
{
"gcId":"645383ba4acec95a32089822",
"noteId" : "6453992d54c74877510e5372"
}
Response Parameter
| Parameter Name | Type | Description |
|---|---|---|
| statuscode | String | Instantpay status code |
| actcode | String | Action code |
| status | String | status message |
| data | Array | Response data(if Present) |
| timestamp | String | Response time (YYYY-MM-DD HH:II:SS) |
| ipay_uuid | String | Request reference number |
| orderid | String | Transaction Id ( If transaction otherwise it is null ) |
| environment | String | Live/Sandbox |
| internalCode | String | it will be null |
{
"statuscode": "TXN",
"actcode": null,
"status": "Note Deleted successfully",
"data": null,
"timestamp": "2023-05-04 17:18:12",
"ipay_uuid": "h0689916131c-7155-4e09-ad4c-51f73390208a",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}