Skip to main content
PATCH
Deactivate

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

active
boolean

Whether or not the affiliate is active.

affiliation_products

Expandable – Property not returned unless expanded.

commission_structure

Expandable – The associated commission structure ID.

portal_url
string | null

A URL that will redirect to this affiliation's correct portal page (hosted or external).

referral_url
string

The referral URL with the affiliate's code appended as a query parameter.

total_commission_amount
integer

The total commission amount earned by the affiliate.

total_not_paid_commission_amount
integer

The total commission amount earned by the affiliate that has not been paid out yet.

clicks

Expandable – Property not returned unless expanded.

referrals

Expandable – Property not returned unless expanded.

payouts

Expandable – Property not returned unless expanded.

discarded_at
integer | null

Time at which the object was discarded. Measured in seconds since the Unix epoch.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.