Update Note

Instantpay's Update Note API helps businesses keep their info accurate and relevant. This API lets you update existing notes on contacts, transactions, or other elements. It ensures your data evolves with changing business needs.

The Update Note API lets businesses improve info in real-time. It helps with clarity and organisation. This tool is ideal for companies with dynamic datasets. It ensures their data is accurate, organised, and up-to-date. Use Instantpay's Update Note API to improve your info management. It will give you precise, relevant data to stay ahead.

Request Parameters

NameTypeRequirementDescription
gcIdStringMandatoryContact Id(You will get from Add Contact Response)
noteIdStringMandatoryNote Unique ID
noteStringMandatoryNotes
removedFilesArrayOptionalRemoved files name
filesArrayOptionalUpload file name

Sample Request

curl --location --request PATCH 'https://api.instantpay.in/contacts/note/update' \
--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="645348b5623454724501cdf7"' \
--form 'noteId="645348b5623454724501cdf7"' \
--form 'note="test 1 file"' \
--form 'removedFiles[]="Files Name in Array"' \
--form 'files[]=@"/path/to/file"'
PATCH /contacts/note/update HTTP/1.1
Host: api.instantpay.in
X-Ipay-Auth-Code: {{authCode}}
X-Ipay-Client-Id: {{clientId}}
X-Ipay-Client-Secret: {{clientSecret}}
X-Ipay-Endpoint-Ip: {{endPointIP}}
Content-Length: 629
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="gcId"

645348b5623454724501cdf7
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="noteId"

645348b5623454724501cdf7
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="note"

test 1 file
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="removedFiles[]"

Files Name in Array
------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="files[]"; filename="file"
Content-Type: <Content-Type header here>

(data)
------WebKitFormBoundary7MA4YWxkTrZu0gW--

Response Parameter

Parameter NameTypeDescription
statuscodeStringInstantpay status code
actcodeStringAction code
statusStringStatus message
dataArrayResponse data(if Present)
timestampStringResponse time (YYYY-MM-DD HH:II:SS)
ipay_uuidStringRequest reference number
orderidStringTransaction Id ( If transaction otherwise it is null )
environmentStringLive/Sandbox
internalCodeStringit will be null
{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Note Updated Successfully",
    "data": {
        "gcId": "645383ba4acec95a32089822",
        "note": "test 1 filedfd"
    },
    "timestamp": "2023-05-04 17:11:42",
    "ipay_uuid": "h005991610cc-8d1c-4fd8-8f38-e169368d9892",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
 
Language
Click Try It! to start a request and see the response here!