Affiliates

The Affiliates API plays a crucial role in managing partners that have onboarded your affiliate programs. Each partner within your program is associated with a unique Affiliate Object, which encapsulates a rich set of information. This data, including their email address, the specific affiliate program they're part of, and their current balance.

One of the key functions provided by the Affiliates API is the ability to manage affiliates effectively. This includes abilities to approve or decline affiliates' applications, reflecting your discretion in forming business relationships. You have the capability to offer bonus payments, bolstering your affiliates' motivation and potentially improving their performance. Conversely, the API also supports the deduction of amounts from their balances, facilitating the management of situations like erroneous payments or policy breaches.

The API additionally grants the ability to remove affiliates from their associated programs. This could be critical in scenarios such as the termination of partnerships or the breach of affiliate agreements.

There are four webhook notification events associated with the Affiliates API.

You can see examples of notification events here:

The default set of permissions are view, edit and remove.