Skip to main content
POST
/
v1
/
referrals
/
churn
Churn Referral
curl --request POST \
  --url https://api.getreditus.com/api/v1/referrals/churn \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "referral_uid": "<string>",
  "referral_email": "<string>",
  "referral_id": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "email": "<string>",
      "state": "<string>",
      "state_set_at": 123,
      "created_at": 123,
      "updated_at": 123
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.getreditus.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Provide at least one identifier. They are matched in order: referral_uid, then referral_id, then referral_email.

referral_uid
string

required if referral_id / referral_email not set - Your internal ID of the referral/user

referral_email
string

required if referral_uid / referral_id not set - Email of the referral

referral_id
string

required if referral_uid / referral_email not set - Reditus id of the referral

Response

Referral was marked as churned

data
object