v1

latestOpenAPI 3.0.12026-07-24501176.6 MB

Refer Customer

post/customer/referrals

Query parameters

mobilestring

Mobile number of the customer. Support values are mobile and email.

Request body

customerstring[]

Array of customer details.

mobilestring required

Mobile number of the customer

referralsobject

Object containing referral information.

campaign_tokenstring

Unique token for the referral campaign.

typestring required

Type of referral Supported values: MOBILE and EMAIL.

idstring required

Unique identifier for the referral.

invited_onstring required

Timestamp indicating when the referral was invited.

namestring

Name of the referred individual.

identifierstring required

Identifier (e.g., mobile number) of the referred individual.

Response

200

Example response

{
  "response": {
    "status": {
      "success": "true",
      "code": 200,
      "message": "SUCCESS"
    },
    "customers": {
      "customer": [
        {
          "mobile": "917999836466",
          "firstname": "shikar",
          "referrals": {
            "referral_type": [
              {
                "type": "MOBILE",
                "referral": [
                  {
                    "name": "Shikhar",
                    "identifier": "7999836416",
                    "invited_on": "20240910T16:35:52.pV7BF",
                    "status": {
                      "success": "true",
                      "code": 1000,
                      "message": "Refer was successful"
                    }
                  }
                ]
              }
            ]
          },
          "item_status": {
            "success": "true",
            "code": 1000,
            "message": "Referrals are invited successfully"
          }
        }
      ]
    }
  }
}