Skip to main content
PATCH
Update a commission rule

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
label
string
payment_target
enum<string> | null
Available options:
partnership,
individual
auto_assign_recipient
enum<string> | null
Available options:
lead_creator,
deal_owner,
manual
calculation
object

Commission calculation with one or more payment entries triggered by deal stage changes.

tier_uuids
string[]
category_uuids
string[]
partnership_uuids
string[]

Response

200 - application/json

Default Response

uuid
string
required
label
string
required
partner_type
enum<string>
required
Available options:
referral,
reseller,
distributor
payment_target
enum<string> | null
required
Available options:
partnership,
individual
auto_assign_recipient
enum<string> | null
required
Available options:
lead_creator,
deal_owner,
manual
calculation
object
required

Commission calculation with one or more payment entries triggered by deal stage changes.

tiers
object[]
required
categories
object[]
required
partnerships
object[]
required
created_at
string
required
updated_at
string
required