Referrals

Capture a referral click

Records a click on a referral link. The body requires the referral code; click_id, landing_path and utm_source, utm_medium and utm_campaign are optional. Returns the click_id to keep in the referral click cookie. An invalid code returns the standard invalid-params error.

post/referrals/click

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/referrals/click
  • Auth: none declared

Request body

click_idstring
codestring
landing_pathstring
utm_campaignstring
utm_mediumstring
utm_sourcestring

Example request

{
  "click_id": "refclk_abc123",
  "code": "A1B2C3D4E5F6",
  "landing_path": "/pricing",
  "utm_campaign": "spring-launch",
  "utm_medium": "email",
  "utm_source": "newsletter"
}

Response

Referral click id

click_idstring
codestring

Example response

{
  "click_id": "refclk_abc123",
  "code": "A1B2C3D4E5F6"
}

Changes

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