Skip to main content
POST
/
referrals
Create referral
curl --request POST \
  --url https://api.affonso.io/v1/referrals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "affiliate_id": "<string>",
  "subscription_id": "<string>",
  "customer_id": "<string>",
  "click_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "status": "lead",
  "name": "<string>",
  "metadata": {}
}
'
{
  "success": true,
  "data": {
    "id": "<string>",
    "affiliate_id": "<string>",
    "program_id": "<string>",
    "email": "<string>",
    "customer_id": "<string>",
    "subscription_id": "<string>",
    "status": "lead",
    "name": "<string>",
    "metadata": {},
    "created_at": "2023-11-07T05:31:56Z",
    "converted_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key authentication. Prefix with 'sk_live_' for production or 'sk_dev_' for development.

Body

application/json
​
email
string<email>
required
​
affiliate_id
string
required
​
subscription_id
string
​
customer_id
string
​
click_id
string

Convert existing click to referral

​
created_at
string<date-time>

Backdate the referral

​
status
enum<string>
default:lead
Available options:
lead,
trialing,
customer,
active,
canceled,
rejected
​
name
string

Customer name

​
metadata
object

Custom key-value data

Response

Referral created

​
success
boolean
​
data
object