Delete Person

Instantpay's Delete Person API helps businesses keep their contact lists current. This API allows you to remove irrelevant contacts with ease. It keeps your contact list focused on valuable connections.

The Delete Person API is ideal for organisations with dynamic contact databases. It simplifies removing outdated or irrelevant individuals. This solution will help businesses. It will streamline their contact management. This will improve the accuracy and the quality of their communications.

Request Parameters

NameTypeRequirementDescription
gcIdStringMandatoryContact Id(You will get from Add Contact Response)
personIdStringMandatoryPerson Id

Sample Request

curl --location --request DELETE '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 '{

    "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 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
{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Person Deleted successfully",
    "data": null,
    "timestamp": "2023-05-04 16:53:20",
    "ipay_uuid": "h00699160a3a-fe31-4aa7-a765-4464f9590db0",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!