How to respond
The response status code your endpoint returns controls the fulfilment state in FirstPromoter:| Status code | Meaning |
|---|---|
200 | Reward fulfilled — FirstPromoter marks it as complete. |
2xx (not 200) | Keep as pending — FirstPromoter leaves the reward in pending state. |
| Any other status | Error — FirstPromoter retries up to 7 times throughout the day. |
Payload
Show properties
Show properties
ID of the reward record.
Status of the reward. Will be
pending at time of this event.Quantity of the reward (e.g., number of free months).
Unit of the reward (e.g.,
free_months, credits).Timestamp of when the reward was created.
Whether any previous fulfilment attempts encountered errors.
The reward rule that generated this reward.
Show properties
Show properties
ID of the reward rule.
Configured reward amount.
Reward type (e.g.,
per_referral, per_promotion).Reward unit.
Name of the reward rule.
Percentage of sale, if commission-based.
Default promo code associated with this reward rule.
The promoter who earned this reward. See Promoter Signs Up for the full promoter object structure.
The campaign the reward is associated with. See Promoter Accepted for the full campaign object structure.
Example
{
"event": {
"id": 13007875,
"type": "fulfilment_pending",
"created_at": "2023-08-23T11:06:02.663Z"
},
"data": {
"id": 2429153,
"status": "pending",
"amount": 3,
"date_paid": null,
"due_date": null,
"unit": "free_months",
"created_at": "2023-08-23T11:06:02.607Z",
"has_issues": false,
"reward": {
"id": 109465,
"amount": null,
"type": "per_promotion",
"unit": "free_months",
"name": "Free subscription months",
"per_of_sale": 0,
"default_promo_code": null
},
"promoter": {
"id": 5272969,
"status": "active",
"cust_id": "",
"email": "[email protected]",
"created_at": "2023-02-08T06:25:28.004Z",
"temp_password": null,
"default_promotion_id": 5680057,
"pref": "i790yc6",
"default_ref_id": "referralid18",
"note": null,
"w8_form_url": null,
"w9_form_url": null,
"parent_promoter_id": null,
"earnings_balance": { "cash": 882, "free_months": 3 },
"current_balance": { "cash": 882, "free_months": 3 },
"paid_balance": null,
"auth_token": "2-5P1Shfk2nnKaZrYFZExh-sfCThGt-2",
"profile": {
"id": 5306304,
"first_name": "Promoter",
"last_name": "Name",
"website": "",
"company_name": "",
"phone_number": "",
"address": "",
"vat_id": "",
"country": "",
"paypal_email": null,
"avatar_url": "",
"description": null,
"social_accounts": {
"twitter": { "url": "" },
"youtube": { "url": "" },
"facebook": { "url": "" },
"linkedin": { "url": "" },
"instagram": { "url": "" }
}
},
"promotions": []
},
"campaign": {
"id": 17476,
"name": "Campaign Name",
"landing_url": "https://www.your-company.com",
"description": "Private campaign with 2 plans",
"private": false,
"color": "#42a5f5",
"default_webhook_url": "https://your-webhook-url.com",
"auto_approve_rewards": true,
"auto_approve_promoters": false,
"offer": null,
"referral_reward": {
"id": 90548,
"amount": null,
"type": "per_referral",
"unit": "cash",
"name": "35% recurring commission",
"per_of_sale": 35,
"default_promo_code": null
},
"promotion_reward": null,
"target_reward": null
}
}
}