Skip to main content
POST
cURL
With this endpoint, you can assign a commission generated by a referral, and it will be recorded to the promoter who referred the lead/customer. You can find the referral by lead_id, email, or UID.

If the reward/commission is not generated by a lead/customer, you can assign it directly to a promoter through its promotion. You can find the promotion by promotion_id or ref_id.
Note: To assign rewards/commission for sales via the API use the Tracking API
If this call is successful and you enabled ‘Promoter gets a new commission/reward’ emails for the campaign, it will send emails to the promoter. To skip the emails, set the skip_email_notification parameter to true

Authorizations

X-API-KEY
string
header
required

Query Parameters

lead_id
string

Lead's id who generated the reward

uid
string

UID of the lead who generated the reward

email
string

Email of the lead who generated the reward.

promotion_id
string

Promotion id of the promoter who owns the reward

ref_id
string

Promotion referral id of the promoter who owns the reward

reward_type
enum<string>
required

Type of reward

Available options:
points,
credits,
free_months,
discount_per,
discount_mon
amount
integer
required

Amount of the reward

status
enum<string>

can be approved(default if this param is omitted), pending or denied

Available options:
approved,
pending,
denied
skip_email_notification
boolean

Set this to true to skip email notifications. Default is false.

Response

Rewards created response

id
number

ID of the reward

status
enum<string>

status of the reward.

Available options:
approved,
pending,
denied
amount
integer

amount of the reward

unit
enum<string>

The reward unit.

Available options:
cash,
credits,
points,
free_months
created_at
string

ISO date string at which the reward is created

lead
any
event_id
string
conversion_amount
integer
tier_level
integer

The reward tier level

promoter
object
promotion
object