Affiliates API
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 api endpoints description method url approve affiliate docid\ xyi7hxb4xopmc y4lcz7u post post /v2/affiliates/approve/\ id decline affiliate docid\ tk48xxqxtpc4oww vwcax post post /v2/affiliates/decline/\ id retrieve affiliate docid 2it jz17gxtlxeeomodvz get get /v2/affiliates/retrieve/\ id delete affiliate docid\ slbxqa2gqvgawhdfghiob delete delete /v2/affiliates/\ id list all affiliates docid 7knd5rglentlyhen qiva get get /v2/affiliates/list list all blocked affiliates docid\ izobjtm6w8aqd9yg6efnw get get /v2/affiliates/blocked/\ id add bonus docid\ pq4xrsen943bpwiju3vsu post post /v2/affiliates/bonus/add/\ id deduct bonus docid\ w0ar86qpql1v779dtcqyc post post /v2/affiliates/bonus/deduct/\ id unblock affiliate docid\ faikzl6zn9imudyww4kbo post post /v2/affiliates/unblock/\ id list all affiliate payouts docid\ l5fnrlsbufoml6tbgzfkc get get /v2/affiliates/payouts/list retrieve affiliate payout docid\ bz wjjlub3oe0ziyicao8 get get /v2/affiliates/payouts/retrieve/\ id send email docid 8ud1ibrlhsag1fqlfbnpr post post /v2/affiliates/send email/\ id webhook events there are four webhook notification events associated with the affiliates api affiliate approved affiliate declined affiliate signup affiliate removed you can see examples of notification events affiliate events docid\ f4blyksxcyj9dpe0if5jp permissions the default set of permissions are view , edit and remove