FirstPromoter icon

FirstPromoter

Interact with the official FirstPromoter APIs

Commission → Create Custom Commission

AI-generated

Summary

Create a custom commission associated with a specific promoter campaign by specifying the commission amount, type, and optional notes or event date. Optionally notify the promoter about the commission via email.

Inputs

  • Commission Amount (required) — The numerical value of the commission to be awarded.
  • Promoter Campaign ID (required) — ID identifying the promoter's participation in a specific campaign, distinct from promoter or campaign IDs.
  • Commission Type (required) — Unit type of the commission reward, options include cash, credits, free months, or points.
  • Event Date — Date/time of the event that led to the commission.
  • Internal Note — Internal note for team visibility only.
  • External Note — External note visible to both the internal team and promoters.
  • Notify Promoter — Boolean flag to send an email notification to the promoter if commission emails are enabled.

Output shape

a single JSON array containing the created commission object as returned by the FirstPromoter API

Returns commission data in JSON format inside an array. If the API call fails, errors or status codes may be returned instead.

Examples

Example 1: Create a cash commission of amount 100 linked to promoter campaign ID 12345, with internal and external notes and notification enabled.

amount=100, promoterCampaignId=12345, unit='cash', internalNote='Checked manually', externalNote='Congrats on your commission!', notifyPromoter=true

Links

Discussion