---
title: "Add Referrals"
method: GET
path: "/customers/{userId}/referrals"
---

# Add Referrals

`GET /customers/{userId}/referrals`

Lets you add customer referral details that contain referees, referred date, and the associated channel.

## Path parameters

- `userId` integer, required

## Request body

- object
  - `customerReferrals` object — Details of customer referrals.
    - `customer` object
      - `id` integer — Unique ID of the customer who is referring.
      - `mobile` string — Mobile number of the customer who is referring.
      - `email` string — Email ID of the customer who is referring.
      - `externalId` string — External ID of the customer who is referring.
    - `campaignToken` string — Unique token generated for the referral campaign.
    - `referrals` object
      - `type` 'MOBILE' | 'EMAIL' — Channel through which the referral details need to be sent - MOBILE, EMAIL.
      - `referral` object
        - `name` string — Name of the referee.
        - `identifier` string — Identifier value of the customer as per the specified `type`.
        - `invitedOn` string, date-time — Date and time of the invitation in YYYY-MM-DDThh:mm:ss.Z.

## Response `200`

200

- object
  - `customerReferrals` object[]
    - `customer` object
      - `id` integer
      - `mobile` string
      - `email` string
      - `externalId` string
    - `campaignToken` string
    - `referrals` object[]
      - `type` string
      - `referral` object[]
        - `name` string
        - `identifier` string
        - `invitedOn` string

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)