POST
/
referrals
curl --request POST \
  --url https://api-dev.withflock.com/referrals \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "campaignId": "<string>",
  "refereeId": "<string>",
  "referralCode": "<string>"
}'
{
  "id": "<string>",
  "campaignId": "<string>",
  "refereeId": {},
  "referrerId": "<string>",
  "status": {},
  "suspectedFrauds": [
    {
      "message": "<string>",
      "type": "<string>"
    }
  ],
  "organizationId": "<string>",
  "applicationId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Body

application/json
​
campaignId
string
required
​
refereeId
string
required

The ID of the customer being invited

​
referralCode
string
required

Response

201 - application/json
​
id
string
required
​
campaignId
string
required
​
refereeId
object | null
required
​
referrerId
string
required
​
status
object
required
​
suspectedFrauds
object[] | null
required
​
organizationId
string
required
​
applicationId
string
required
​
createdAt
string
required
​
updatedAt
string
required
​
deletedAt
string | null
required