post https://api.instantpay.in/contacts/note
Instantpay's Add Note API helps businesses add useful context to their data. This versatile tool lets you add notes to contacts, transactions, and other key items. It ensures that critical details are captured and easy to find.
The Add Note API is a simple way to annotate info. Use it to document customer interactions, record transaction insights, or set reminders. This API will enrich business data with more context. It will help with decision-making and improve communication across the organisation.
Request Parameters
Name | Type | Requirement | Description |
---|---|---|---|
gcId | String | Mandatory | Contact Id(You will get from Add Contact Response) |
note | String | Mandatory | Notes |
files | Array | Mandatory | Uploaded Files |
Sample Request
curl --location 'https://api.instantpay.in/contacts/note' \
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
--form 'gcId="111111111111"' \
--form 'note="Added Successfully"' \
--form 'files[]=@"/path/to/file"'
POST /contacts/note HTTP/1.1
Host: api.instantpay.in
--header 'X-Ipay-Auth-Code: {{authCode}}' \
--header 'X-Ipay-Client-Id: {{clientId}}' \
--header 'X-Ipay-Client-Secret: {{clientSecret}}' \
--header 'X-Ipay-Endpoint-Ip: {{endPointIP}}' \
Content-Length: 397
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="gcId"
111111111111
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="note"
Added Successfully
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files[]"; filename="file"
Content-Type: <Content-Type header here>
(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW--
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 |
"statuscode": "TXN",
"actcode": null,
"status": "Note Added Successfully",
"data": {
"gcId": "645383ba4acec95a32089822",
"note": "test 1 files",
"updated_at": "2023-05-04T11:38:21.792000Z",
"created_at": "2023-05-04T11:38:21.792000Z",
"_id": "6453992d54c74877510e5372"
},
"timestamp": "2023-05-04 17:08:23",
"ipay_uuid": "h00699160f9a-8cd3-4453-a3b1-3d1b41b5373a",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}