02054 – De-Activate User from Forum via API

If you are using a Payment System that does not have deep integration with 10XPRO.io (Stripe, PayPal or Infusionsoft), then simply follow these steps to cancel your member and de-activate him from your Forum via API.

  • In your 10XPRO site, go to Settings in the left-sidebar menu, then select Integrations.
  • Scroll down and click on the Custom API toggle.
  • Under Cancellation, copy the API URL provided.

NB! We now have secret key support to prevent somebody else sending registration webhooks to your site.

To change the secret key for your API URL, simply go to Settings > Global Settings. Then, go to Webhooks Secret Key and click on the Generate New Secret button and a new secret key will be added. 

 

Go back to your Payment 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 System to send a HTTP Post to your 10XPRO site when someone cancels.
    • In Post URL field: Paste the Custom API URL you copied from your 10XPRO site
    • Then you want to add the following parameter name/value pairs
      i.e. parameter name -> parameter value:

Required Parameters:
type => credit
(note: the literal word “credit” must be used as the value)

email => the client email to be made inactive
(note: if you want to automate this process you can add your system’s merge fields for the user’s email).

forum_full_access => `yes` to remove user user full forum access

forum_category_id => the ID of the Forum category

 

Setup a HTTP Get
    • Follow the steps provided by your Payment System to send a HTTP Get to your 10XPRO site when someone cancels.
    • In ‘Get’ URL field: Paste the Custom API URL you copied from your 10XPRO site
    • 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.

Required Parameters:
type => credit
(note: the literal word “credit” must be used as the value)

email => the client email to be made inactive
(note: if you want to automate this process you can add your system’s merge fields for the user’s email).

forum_full_access => `yes` to remove user user full forum access

forum_category_id => the ID of the Forum category

An example HTTP Get would look something like this:
https://yourdomainname.com/customapi.php?secret=XYZ&type=credit&forum_full_access=yes&email=ADDEMAILMERGE

Related Articles

De-Activate User from An Online Course via API
De-Activate User from Bundle via API