Payload
Show properties
Show properties
The newly signed-up promoter.
Show properties
Show properties
ID of the promoter.
Status of the promoter. Will typically be
pending until accepted, or active if auto-approval is enabled.External customer ID, if provided.
Email address of the promoter.
Timestamp of when the promoter was created.
Auto-generated temporary password sent to the promoter on signup.
ID of the promoter’s default promotion.
Internal preference token.
Default referral ID used in links.
Admin note on the promoter’s profile.
URL of the W-8 tax form, if uploaded.
URL of the W-9 tax form, if uploaded.
ID of the parent promoter in a multi-tier setup.
Total commissions earned, broken down by unit.
Current unpaid balance, broken down by unit.
Total paid out balance, broken down by unit.
Authentication token for the promoter’s affiliate dashboard.
Show properties
Show properties
ID of the profile.
First name.
Last name.
Website URL.
Company name.
Phone number.
Mailing address.
VAT identification number.
Two-letter country code.
PayPal email for payouts.
URL of the promoter’s avatar image.
Bio or description.
Social profile URLs keyed by platform (
twitter, youtube, facebook, linkedin, instagram, tiktok, twitch). Each entry has a url string.Array of campaign promotions the promoter was enrolled in at signup. See Lead Signup for the full promotion object structure.
Example
{
"event": {
"id": 22733100,
"type": "promoter_signed_up",
"created_at": "2024-10-03T11:45:10.312Z"
},
"data": {
"promoter": {
"id": 9000800,
"status": "pending",
"cust_id": null,
"email": "newaffiliate@example.com",
"created_at": "2024-10-03T11:45:10.102Z",
"temp_password": "XPQ-rT",
"default_promotion_id": 11027500,
"pref": "cx2mn4z",
"default_ref_id": "cx2mn",
"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": "zK8mNpQwRtUvXyA2BcDeFgHiJkLmNoP",
"profile": {
"id": 9048200,
"first_name": "Jane",
"last_name": "Smith",
"website": "https://www.janesmith.com",
"company_name": "Smith Media",
"phone_number": null,
"address": "",
"vat_id": "",
"country": "US",
"paypal_email": null,
"avatar_url": null,
"description": null,
"social_accounts": {
"tiktok": { "url": "" },
"twitch": { "url": "" },
"twitter": { "url": "https://twitter.com/janesmith" },
"youtube": { "url": "" },
"facebook": { "url": "" },
"linkedin": { "url": "" },
"instagram": { "url": "" }
}
}
},
"promotions": [
{
"id": 11027500,
"status": "offer_running",
"ref_id": "cx2mn",
"promo_code": null,
"customer_promo_code": null,
"target_reached_at": null,
"promoter_id": 9000800,
"campaign_id": 13202,
"referral_link": "https://www.example.com?_get=cx2mn",
"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
}
]
}
}