Skip to main content

Documentation Index

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

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

Your endpoint will receive this event when a promoter’s application to a campaign is accepted — either manually by an admin or automatically if auto_approve_promoters is enabled on the campaign.

Payload

event
object
data
object

Example

{
  "event": {
    "id": 22733469,
    "type": "promoter_accepted",
    "created_at": "2024-10-03T11:57:31.228Z"
  },
  "data": {
    "state": "accepted",
    "campaign": {
      "id": 13202,
      "name": "Main Campaign",
      "landing_url": "https://www.example.com",
      "description": "",
      "private": false,
      "color": "#42a5f5",
      "default_webhook_url": "https://hooks.example.com/firstpromoter",
      "auto_approve_rewards": true,
      "auto_approve_promoters": false,
      "offer": {
        "id": 67212,
        "name": "5% discount coupon",
        "amount": 5,
        "unit": "discount_per",
        "default_promo_code": "EXAMPLE-5"
      },
      "referral_reward": {
        "id": 128312,
        "amount": 0,
        "type": "per_referral",
        "unit": "cash",
        "name": "20% recurring commission",
        "per_of_sale": 20,
        "default_promo_code": ""
      },
      "promotion_reward": {
        "id": 68347,
        "amount": null,
        "type": "per_promotion",
        "unit": "free_months",
        "name": "Free subscription months",
        "per_of_sale": 0,
        "default_promo_code": null
      },
      "target_reward": null
    },
    "promoter": {
      "id": 9000754,
      "status": "active",
      "cust_id": null,
      "email": "promoter@example.com",
      "created_at": "2024-10-03T11:57:30.943Z",
      "temp_password": "VKD-uS",
      "default_promotion_id": 11027468,
      "pref": "bh4oj6x",
      "default_ref_id": "myrefid",
      "note": null,
      "w8_form_url": null,
      "w9_form_url": null,
      "parent_promoter_id": null,
      "earnings_balance": null,
      "current_balance": null,
      "paid_balance": null,
      "auth_token": "nu9NhM6Hza-kybjZZJivC-FgMtxMrT_o",
      "profile": {
        "id": 9048173,
        "first_name": "Cooper",
        "last_name": "Faulkner",
        "website": "https://www.cooperfaulkner.com",
        "company_name": "Faulkner Media",
        "phone_number": null,
        "address": "",
        "vat_id": "",
        "country": "AU",
        "paypal_email": null,
        "avatar_url": null,
        "description": null,
        "social_accounts": {
          "tiktok": { "url": "" },
          "twitch": { "url": "" },
          "twitter": { "url": "" },
          "youtube": { "url": "" },
          "facebook": { "url": "" },
          "linkedin": { "url": "" },
          "instagram": { "url": "" }
        }
      },
      "promotions": []
    },
    "promotion": {
      "id": 11027468,
      "status": "offer_running",
      "ref_id": "myrefid",
      "promo_code": null,
      "customer_promo_code": null,
      "target_reached_at": null,
      "promoter_id": 9000754,
      "campaign_id": 13202,
      "referral_link": "https://www.example.com?_get=myrefid",
      "current_offer": {
        "id": 67212,
        "name": "5% discount coupon",
        "amount": 5,
        "unit": "discount_per",
        "default_promo_code": "EXAMPLE-5"
      },
      "current_referral_reward": {
        "id": 128312,
        "amount": 0,
        "type": "per_referral",
        "unit": "cash",
        "name": "20% recurring commission",
        "per_of_sale": 20,
        "default_promo_code": ""
      },
      "current_promotion_reward": null,
      "current_target_reward": null,
      "campaign_name": "Main Campaign",
      "hidden": false,
      "visitors_count": 0,
      "leads_count": 0,
      "customers_count": 0,
      "refunds_count": 0,
      "cancellations_count": 0,
      "sales_count": 0,
      "sales_total": 0,
      "refunds_total": 0,
      "active_customers_count": 0
    }
  }
}