Articles

Welcome to ZoneVu's Knowledge Base

Support content and general information

Web API and Python Scripting

Creating Your API Delete Code

This article explains how to generate an API Delete Code for use with the ZoneVu API. The Delete Code is required for performing destructive operations such as deleting Wells, Documents, or other Data Objects. This additional layer of authentication ensures that only authorized users can perform high‑impact actions.

Last updated on 26 Feb, 2026

Overview

A Delete Code is a short‑lived authorization code tied to your ZoneVu user account. To generate a Delete Code, you must be using a valid API Key for an account that includes a confirmed phone number or email address you can access. ZoneVu sends the Delete Code directly to that contact method for security verification.

Prerequisites

Before generating a Delete Code, ensure that:

  • You are using a valid API Key for your ZoneVu account.

  • Your account includes a confirmed phone number and/or email address you have access to.

  • You have permissions (based on your Roles) to perform delete operations.

How to Generate an API Delete Code

Generating a Delete Code is done through a single API call.

1. Ensure you are authenticated with a valid API Key

Your script or application must already be using your API Key to authenticate.
If you need help, see: Creating Your API Key in ZoneVu.

2. Call the Delete Authorization Endpoint

Make a request to:

/api/v1.1/company/deleteauth

When this endpoint is called, ZoneVu will automatically send a Delete Code to the phone number or email address associated with your account.

3. Retrieve the Delete Code

Check your:

  • Email inbox

  • SMS messages

The Delete Code will be delivered to one or both, depending on your account settings.

4. Use the Delete Code in Your Delete Requests

Once received, provide the Delete Code in any API call requiring delete authorization.

Use the call below for the Delete Code:

deletecode=xXxXxXx

Example: 
api/v1.1/well/delete/<wellId>?deletecode=xXxXxXx

These are the calls that require a Delete Code

api/v1.1/completions/frac/delete/
api/v1.1/geomodel/datagrid/delete/
api/v1.1/geosteer/interpretation/delete/
api/v1.1/notes/delete/
api/v1.1/project/delete/
api/v1.1/survey/delete/
api/v1.1/surveymod/delete/
api/v1.1/welllog/delete/
api/v1.1/well/delete/

Note: Delete Codes have a time to live of 24 hours, after which time a new code will need to be generated.

Security Notes

Note: Your Delete Code should never be shared. Treat it like your API Key and safeguard it accordingly.

Note: Delete Codes have a time‑to‑live of 24 hours. After this period expires, a new Delete Code must be generated.

Did you find this article helpful?
Previous

Setting Up an API Key File on Your Computer

Next

© 2026 Ubiterra - Home of ZoneVu.