Setting Up In-App Cancelation Button

Let users cancel a submitted request from inside your app by calling the MineOS Close Request API

Just as you can let users request account deletion from inside your app, you can add a button that lets them cancel a privacy request they've already submitted — for example, withdrawing a pending deletion request. The button calls the MineOS API to close the request with a Canceled outcome.

Background

Canceling a request — closing it with a Canceled outcome — is available through the MineOS API rather than the portal, which makes it a good fit for an in-app control your users can trigger themselves.

Step 1: Add a cancelation button in your app

Add a button in your app that lets the user cancel their request. This button should call an endpoint in your app's backend, which in turn calls the MineOS API.

Best practices:

  • Place the button behind login — for example, on the account or request-status page — so you already have the user's details and the ID of the request to cancel.
  • Confirm the action with the user before canceling.
  • Re-authenticate (password or OTP) if the session isn't fresh, to ensure it's the legitimate account owner.
  • Never call the MineOS API directly from your app. That would require shipping your MineOS API key in the app bundle, which is insecure — always call it from your backend.

Step 2: Call the MineOS Close Request API

First, create an API key for your MineOS account (see the Authentication guide).

From your backend, call the MineOS Close Request API with your API key, providing:

  • ticketId — the ID of the request to cancel. You receive this when the request is created via the Create Request API, so store it so you can cancel the request later.
  • reason — set to Canceled.

Optional parameters let you skip automation or choose the email template used when closing. See the MineOS API reference for the close-request endpoint and its full set of parameters.

Step 3: What happens next

Once the request is closed as canceled, MineOS stops processing it and records it as canceled. Any email the user receives uses the templates configured for your DSR workflow.


Did this page help you?