Archive rule
curl --request DELETE \
--url https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId} \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-API-Key: <api-key>'import requests
url = "https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}"
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-API-Key": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'Idempotency-Key': '<idempotency-key>', 'X-API-Key': '<api-key>'}
};
fetch('https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Idempotency-Key: <idempotency-key>",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "rul_8Q2mVtP0aXk1LzR4nJ6b7c",
"customerId": "cus_4rT7mA9sL1kBc6dV8xN2pQ",
"status": "active",
"trigger": {
"type": "funds_received",
"accountId": "acc_6dV8xN2pQ4rT7mA9sL1kBc"
},
"action": {
"type": "transfer",
"target": {
"type": "destination",
"id": "dst_7mA9sL1kBc6dV8xN2pQ4rT"
}
},
"label": "Operating wallet sweep",
"createdAt": "2026-07-10T09:15:00.000Z",
"updatedAt": "2026-07-10T09:15:00.000Z",
"archivedAt": null
}
}rules
Archive rule
Archiving is terminal and frees the trigger account for a new rule. The archived rule stays readable.
Archive rule
curl --request DELETE \
--url https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId} \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-API-Key: <api-key>'import requests
url = "https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}"
headers = {
"Idempotency-Key": "<idempotency-key>",
"X-API-Key": "<api-key>"
}
response = requests.delete(url, headers=headers)
print(response.text)const options = {
method: 'DELETE',
headers: {'Idempotency-Key': '<idempotency-key>', 'X-API-Key': '<api-key>'}
};
fetch('https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "DELETE",
CURLOPT_HTTPHEADER => [
"Idempotency-Key: <idempotency-key>",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}")
.header("Idempotency-Key", "<idempotency-key>")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.swipelux.com/v3/customers/{customerId}/rules/{ruleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"id": "rul_8Q2mVtP0aXk1LzR4nJ6b7c",
"customerId": "cus_4rT7mA9sL1kBc6dV8xN2pQ",
"status": "active",
"trigger": {
"type": "funds_received",
"accountId": "acc_6dV8xN2pQ4rT7mA9sL1kBc"
},
"action": {
"type": "transfer",
"target": {
"type": "destination",
"id": "dst_7mA9sL1kBc6dV8xN2pQ4rT"
}
},
"label": "Operating wallet sweep",
"createdAt": "2026-07-10T09:15:00.000Z",
"updatedAt": "2026-07-10T09:15:00.000Z",
"archivedAt": null
}
}Authorizations
Your Swipelux API key. Obtain this from the Swipelux Dashboard.
Headers
Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.
Required string length:
1 - 255Response
Rule archived
Show child attributes
Show child attributes
⌘I