Skip to main content

Partners API

Manage partnership organizations (Visa, HDFC, corporate tie-ups).

Base path: /api/v1/admin/partners

List Partners​

GET /api/v1/admin/partners
[
  {
    "id": "VISA",
    "name": "Visa International",
    "contactEmail": "[email protected]",
    "channelId": null,
    "defaultUtmSource": "visa_partnership",
    "status": "ACTIVE"
  },
  {
    "id": "HDFC",
    "name": "HDFC Bank",
    "contactEmail": "[email protected]",
    "channelId": "B2B_HDFC",
    "defaultUtmSource": "hdfc_cards",
    "status": "ACTIVE"
  }
]

Get Partner​

GET /api/v1/admin/partners/{id}

Create Partner​

POST /api/v1/admin/partners
{
  "id": "VISA",
  "name": "Visa International",
  "contactEmail": "[email protected]",
  "channelId": null,
  "defaultUtmSource": "visa_partnership",
  "status": "ACTIVE",
  "metadata": { "tier": "platinum", "contractEnd": "2027-03-31" }
}

Update Partner​

PUT /api/v1/admin/partners/{id}
{
  "name": "Visa International",
  "status": "INACTIVE"
}

Delete Partner​

DELETE /api/v1/admin/partners/{id}

Partners send traffic via:

https://elivaas.com/?partner_id=VISA
https://elivaas.com/?partner_id=VISA&utm_source=visa_email&utm_campaign=summer

Or via API header:

X-Partner-Id: VISA