Add Tag

Request Parameters

NameTypeRequirementDescription
nameStringMandatoryTag Name
hexColorCodeStringMandatoryColor Code

Sample Request

curl --location 'https://api.instantpay.in/contacts/tag' \
--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 '{
    "name": "Sample Name",
    "hexColorCode": "#FF1934"
}'
POST /contacts/tag 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-Type: application/json
Content-Length: 57

{
    "name": "Sample Name",
    "hexColorCode": "#FF1934"
}

Response Parameters

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

Sample Response

{
    "statuscode": "TXN",
    "actcode": null,
    "status": "Tag Added Successfully",
    "data": {
        "userId": 432352,
        "name": "Testing",
        "hexColorCode": "#FF1934",
        "updated_at": "2023-05-04T09:22:32.581000Z",
        "created_at": "2023-05-04T09:22:32.581000Z",
        "_id": "645379580f08b4af410594f2"
    },
    "timestamp": "2023-05-04 14:52:32",
    "ipay_uuid": "h0069915df07-b290-4b6f-9fd0-84e7601a52e9",
    "orderid": null,
    "environment": "LIVE",
    "internalCode": null
}
Language
Click Try It! to start a request and see the response here!