patch https://api.instantpay.in/contacts/person
Instantpay’s Update Person API is vital for businesses. It helps them keep individual contact info accurate and current. This API allows you to update details for individuals with minimal effort. It covers role changes, contact updates, and other critical info. It keeps your database current and accurate.
The Update Person API has real-time contact management. It helps businesses communicate and manage relationships. Integrating this API will keep contact info reliable. It will enable better interactions with their contacts.
Request Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| personId | String | Mandatory | Id of the Person |
| gcId | String | Mandatory | Contact Id(You will get from Add Contact Response) |
| contactPersonName | String | Mandatory | Name of the Person |
| String | Mandatory | Email Id | |
| mobile | String | Mandatory | Mobile Number |
| description | String | Mandatory | Remarks |
Sample Request
curl --location --request PATCH 'https://api.instantpay.in/contacts/person' \
--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-raw '{
"personId" : "6453951835fca2f80f074002",
"gcId" : "645383ba4acec95a32089822",
"contactPersonName" : "Sample Name",
"email" : "[email protected]",
"mobile" : "7428585742",
"description" : "test desc"
}'
PATCH /contacts/person 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: 238
{
"personId" : "6453951835fca2f80f074002",
"gcId" : "645383ba4acec95a32089822",
"contactPersonName" : "Sample Name",
"email" : "[email protected]",
"mobile" : "7428585742",
"description" : "test desc"
}'
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": "Contact Person Updated Successfully",
"data": {
"gcId": "645383ba4acec95a32089822",
"contactPersonName": "Sample Name",
"email": "[email protected]",
"mobile": "7428585742",
"description": "test desc",
"callingCode": "+91"
},
"timestamp": "2023-05-04 16:51:52",
"ipay_uuid": "h006991609b4-b4c5-4327-ae8d-77536300adc5",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}