get https://api.instantpay.in/contacts/profile
Instantpay's List Contact API is a powerful tool. It gives businesses a complete view of their contact database. Our API gives you a full list of your contacts providing insights that improves understanding of your network.
Integrating the List Contact API lets businesses analyse and segment their contacts. This supports more targeted, personalised communication. This feature helps you build stronger, meaningful relationships. It fosters informed and strategic interactions.
The List Contact API suits businesses that want to optimise contact management. It promotes organised, data-driven relationship-building.
Request Parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
| gcId | String | Mandatory | Contact Id(You will get from Add Person Response) |
| personId | String | Mandatory | Person Id |
Sample Request
curl --location --request DELETE 'https://api.instantpay.in/contacts/person' \
--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",
"personId" : "6453951835fca2f80f074002"
}
'
DELETE /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: 88
{
"gcId":"645383ba4acec95a32089822",
"personId" : "6453951835fca2f80f074002"
}
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": "Transaction Successful",
"data": [
{
"_id": "645b283b9b2e242ec80dd5c2",
"userId": 189590,
"name": "Sample Name",
"email": "[email protected]",
"mobile": "7428585742",
"callingCode": "91",
"companyName": "XYZ",
"tagId": [
"645b280e95335f08eb021aa2"
],
"tags": [
{
"_id": "645b280e95335f08eb021aa2",
"userId": 189590,
"name": "Employee1",
"hexColorCode": "#FF1934",
"updated_at": "2023-05-10T05:13:50.517000Z",
"created_at": "2023-05-10T05:13:50.517000Z"
}
]
}
],
"timestamp": "2023-05-10 10:45:08",
"ipay_uuid": "h00599219875-45b5-485f-8dfb-9ed9ed5b37fd",
"orderid": null,
"environment": "LIVE",
"internalCode": null
}