Test API keyRuns examples for real against your account. Test keys only; kept in this tab, never stored on our side. Get a key

Delete an action

DELETE/v1/actions/{name}

Delete an action’s declaration. Links that name it keep working: clicks are still tracked and still reach webhooks filtered on it.

Requires a full-access live key; test keys get 403 test_key_restricted.

While links or webhooks still use it, the action stays in the catalogue with declared: false.

Path parameters

namestringrequired: Action name, as written in data-zap-action.

Errors

restricted_api_keyHTTP 403
test_key_restrictedHTTP 403: test-mode keys can send test email and read, not change the account: use a live key
not_foundHTTP 404: action not found (not declared)

curl -X DELETE 'https://zapsmtp.xyz/v1/actions/confirm_order' \
  -H "Authorization: Bearer $ZAP_API_KEY"

const res = await fetch('https://zapsmtp.xyz/v1/actions/confirm_order', {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.ZAP_API_KEY}`,
  },
});
// 204 No Content (e.g. a delete) has no body
const data = res.status === 204 ? null : await res.json();
if (!res.ok) throw new Error(`${data.name}: ${data.message}`);
console.log(data);

import os
import requests

res = requests.delete(
    "https://zapsmtp.xyz/v1/actions/confirm_order",
    headers={"Authorization": f"Bearer {os.environ['ZAP_API_KEY']}"},
    timeout=30,
)
res.raise_for_status()
print(res.json() if res.status_code != 204 else "deleted")

<?php
$ch = curl_init('https://zapsmtp.xyz/v1/actions/confirm_order');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('ZAP_API_KEY'),
    ],
]);
$data = json_decode(curl_exec($ch), true);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
if ($status >= 400) {
    throw new RuntimeException($data['message']);
}
print_r($data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"os"
)

func main() {
	req, err := http.NewRequest(
		"DELETE",
		"https://zapsmtp.xyz/v1/actions/confirm_order",
		nil,
	)
	if err != nil {
		panic(err)
	}
	req.Header.Set("Authorization", "Bearer "+os.Getenv("ZAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.Status, string(out))
}

require 'net/http'
require 'json'

uri = URI('https://zapsmtp.xyz/v1/actions/confirm_order')
req = Net::HTTP::Delete.new(uri)
req['Authorization'] = "Bearer #{ENV.fetch('ZAP_API_KEY')}"

res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts res.code, (JSON.parse(res.body) unless res.body.to_s.empty?)

import java.net.URI;
import java.net.http.*;

public class ZapRequest {
    public static void main(String[] args) throws Exception {
        var request = HttpRequest.newBuilder(URI.create("https://zapsmtp.xyz/v1/actions/confirm_order"))
            .header("Authorization", "Bearer " + System.getenv("ZAP_API_KEY"))
            .method("DELETE", HttpRequest.BodyPublishers.noBody())
            .build();
        var response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

using System.Net.Http.Headers;
using System.Text;

using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://zapsmtp.xyz/v1/actions/confirm_order");
request.Headers.Authorization = new AuthenticationHeaderValue(
    "Bearer", Environment.GetEnvironmentVariable("ZAP_API_KEY"));

var response = await http.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");

Set ZAP_API_KEY in your environment.

Response 200 OK

{
  "object": "action",
  "name": "confirm_order",
  "deleted": true
}