incentives

Update Public Incentive Plan

patch/v2/public/incentives/plans/{plan_id}

Request

Base URL
https://api.sanka.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sankahq/apis/sanka-public-api/docs/v2/public/incentives/plans/:plan_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

plan_idstring required

workspace_idstring nullable

X-Workspace-Codestring

namestring nullable

statusstring nullable

base_eventstring nullable

source_statusstring nullable

source_company_idstring nullable

payee_typestring nullable

payee_company_idstring nullable

amount_basisstring nullable

rate_typestring nullable

rate_valuenumber nullable

effective_fromstring date nullable

effective_tostring date nullable

min_amountnumber nullable

max_payout_amountnumber nullable

Successful Response

successtrue required

dataobject required