Convert referral
Mark a referral as converted and trigger advocate and friend rewards.
POST /api/app/campaigns/{campaignId}/referrals/{referralId}/convert
Marks a referral as converted. This records the conversion, credits the advocate's balance, promotes the friend to an advocate with their own referral link and portal, and sends reward notifications to both parties.
Request
See API Basics for required headers.
Body
| Field | Type | Required | Description |
|---|---|---|---|
jobValueCents | integer | Conditional | Total job value in cents. Required for percent campaigns — reward amounts are calculated from this value. Ignored for fixed campaigns. |
For fixed campaigns the request body may be omitted entirely. For percent campaigns, jobValueCents must be a positive integer representing the total job value in cents — e.g. 75000 for a $750 job.
Sample request — fixed campaign
curl -X POST https://api.recomly.com/api/app/campaigns/c7a3f1d2-84b0-4e9a-bcd2-1f3e5a7c9012/referrals/g1e7c5d3-94f6-4h0g-ceg7-5i7j9k1l2345/convert \
-H "Authorization: Bearer rk_live_abc123:def456"Sample request — percent campaign
curl -X POST https://api.recomly.com/api/app/campaigns/d8b4e2c1-93c1-4f0b-ace3-2e4f6b8d0123/referrals/g1e7c5d3-94f6-4h0g-ceg7-5i7j9k1l2345/convert \
-H "Authorization: Bearer rk_live_abc123:def456" \
-H "Content-Type: application/json" \
-d '{
"jobValueCents": 75000
}'Sample response
Status: 200 OK
{
"ok": true,
"conversionId": "k5i1g9h7-38j0-4l4k-ghk1-9m1n3o5p6789",
"advocateNewBalance": 5000
}advocateNewBalance is the advocate's updated credit balance in cents after the reward has been applied.
Error responses
See API Basics for standard status codes and error response format.