Skip to main content
POST
Attribute a referring partner
Learn more about Partner Referral Rewards.

Authorizations

Authorization
string
header
required

Default authentication mechanism

Body

application/json
partnerId
string | null

The ID of the partner to attribute to a referring partner. Takes precedence over tenantId if both are provided.

tenantId
string | null

The ID in your system of the partner to attribute to a referring partner. Either partnerId or tenantId is required.

referredByPartnerId
string | null

The ID of the referring partner. Takes precedence over referredByTenantId if both are provided.

referredByTenantId
string | null

The ID in your system of the referring partner. Either referredByPartnerId or referredByTenantId is required.

createCommissionsForPastEvents
boolean
default:false

Whether to create referral commissions for the partner's eligible past events. Skipped when the referring partner has no referral reward.

Response

The partner was attributed to the referring partner.

partnerId
string
required

The ID of the attributed partner.

referredByPartnerId
string
required

The ID of the referring partner.