Sign in

v9

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-212974381.2 MB
incentives

Create Public Incentive Plan

post/v2/public/incentives/plans

Query parameters

workspace_idstring nullable

Headers

X-Workspace-Codestring

Request body

namestring required
base_eventstring required
rate_typestring required
rate_valuenumber required
effective_fromstring date required
effective_tostring date nullable
statusstring
source_statusstring nullable
source_company_idstring nullable
payee_typestring
payee_company_idstring nullable
amount_basisstring
min_amountnumber nullable
max_payout_amountnumber nullable

Response

Successful Response

successtrue required
dataobject required