11011 – Remove user from an Affiliate Commission Program via API

The Affiliate Cancellation Webhook allows you to remove Affiliates from specific Commission Programs automatically, when they no longer need access or no longer participating in your Affiliate Program.

Setup Cancellation Registration Webhook

In your KLEQ site, go to Affiliates in the left-sidebar menu.
In the next screen open one of the Commission Programs you would like edit.

 

In the pop-up that appears, under Cancellation Webhook, copy the API URL provided.

Go back to your Payment (or Email) System. Check with their support team if they support HTTP Post or HTTP Get integrations. If they do then simply setup one of these two options:

Setup a HTTP Post
  • Follow the steps provided by your Payment (or Email) System to send a HTTP Post to your KLEQ site to remove an Affiliate from one of your Commission Programs.
  • In Post URL field: Paste the Custom API URL you copied from the Commission Program.
  • Then you want to add the following parameter name/value pairs
    i.e. parameter name -> parameter value:
    contactEmail-> Insert the client email
    (note: if you want to automate this process you can add your system’s merge fields for the client’s email).
Setup a HTTP Get
  • Follow the steps provided by your Payment (or Email) System to send a HTTP Get to your KLEQ site to remove an Affiliate from one of your Commission Programs.
  • In ‘Get’ URL field: Paste the Custom API URL you copied from the Commission Program.
  • Then you want to add the following parameter name/value pairs to the end of your API URL. Note: How this is done, will depend on the Payment System you are using.
    contactEmail-> Insert the client email
    (note: if you want to automate this process you can add your system’s merge fields for the client’s email).An example HTTP Get would look something like this:
    https://yourdomainname.com/affiliate.php?ap=1&h=935eee&contactEmail=ADDEMAILMERGE&firstName=ADDFIRSTNAMEMERGE&lastName=ADDLASTNAMEMERGE
IMPORTANT: There is a limit of 100 requests per minute. This is to protect your site from too many requests. If too many requests are sent, then once the 100 limit cap is reached, any extra requests will be ignored.

Related Article

11010 – Register user to an Affiliate Commission Program via API