Referrals

Hold an attributed referral for review

Puts an attributed referral, identified by path id, into manual review. Optional body field reason records why. The attribution moves to review_required, gets a manual_review risk flag and earns no rewards. If it is no longer attributed, the current record comes back unchanged.

post/admin/referrals/{id}/hold

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/admin/referrals/{id}/hold
  • Auth: API key in header x-api-key

Path parameters

idstring required

Referral attribution id

Headers

x-api-keystring required

Admin API key

Request body

reasonstring

Example request

{
  "reason": "same billing account"
}

Response

Review result

Example response

{
  "attribution": {
    "click_id": "refclk_abc123",
    "code": "A1B2C3D4E5F6",
    "error": "temporary billing write failure",
    "first_paid_invoice_id": "in_123",
    "id": "attr-1",
    "landing_path": "/pricing",
    "referred_user_id": "user-referred",
    "referrer_user_id": "user-referrer",
    "review_reason": "same_stripe_customer",
    "reviewed_by": "admin-user",
    "risk_flags": [
      "same_stripe_customer"
    ],
    "skip_reason": "capped",
    "status": "rewarded",
    "stripe_event_id": "evt_123",
    "stripe_invoice_id": "in_123",
    "utm_campaign": "spring-launch",
    "utm_medium": "email",
    "utm_source": "newsletter"
  },
  "rewards": [
    {
      "attribution_id": "attr-1",
      "credits": 10000,
      "credits_grant_error": "temporary billing write failure",
      "credits_grant_key": "reward-1",
      "id": "reward-1",
      "role": "referrer",
      "stripe_invoice_id": "in_123",
      "user_id": "user-referrer"
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.