Skip to main content
PUT
/
referrals
/
{id}
Update referral
curl --request PUT \
  --url https://api.affonso.io/v1/referrals/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "subscription_id": "<string>",
  "customer_id": "<string>",
  "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.

Path Parameters

id
string
required

Referral ID

Body

application/json
email
string<email>
subscription_id
string
customer_id
string
status
enum<string>
Available options:
lead,
trialing,
customer,
active,
canceled,
rejected
name
string

Customer name

metadata
object

Custom key-value data

Response

Referral updated

success
boolean
data
object