Numbers

Purge number

PERMANENTLY destroys the number, immediately — IRREVERSIBLE, there is no restore afterwards. Erases the number and everything under it (message history, chats, templates, webhooks scoped to it, its API keys) and deregisters a Meta number at Meta. Accepts a number already deleted with DELETE /v1/numbers/{id} (the usual flow: delete, then purge) or an active one. Use it when the SAME phone has to be created again right away. It saves nothing on the bill compared to DELETE. Use a TENANT-scoped key: a key bound to the deleted number stops authenticating once the number is deleted. With an OAuth/MCP token, only the workspace OWNER may purge (403 PERMISSION_DENIED otherwise).

DELETE

numbers

{id}

purge

Purge number (permanent delete)

curl --request DELETE \
  --url https://pilotstatus.com.br/v1/numbers/{id}/purge \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/numbers/{id}/purge', 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://pilotstatus.com.br/v1/numbers/{id}/purge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "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://pilotstatus.com.br/v1/numbers/{id}/purge"

	req, _ := http.NewRequest("DELETE", url, nil)

	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))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/numbers/{id}/purge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "ok": true
}

{
  "error": "Unauthorized"
}

{
  "error": "Your workspace role does not allow this action (numbers:purge).",
  "code": "PERMISSION_DENIED"
}

{
  "error": "Not found"
}

{
  "error": "Too many requests"
}

Authorizations

x-api-key

string

header

required

Your ps_ API key

Path Parameters

string

required

Id of the number to destroy (active or already deleted).

Response

Number purged

Purge number (permanent delete)

curl --request DELETE \
  --url https://pilotstatus.com.br/v1/numbers/{id}/purge \
  --header 'x-api-key: <api-key>'

const options = {method: 'DELETE', headers: {'x-api-key': '<api-key>'}};

fetch('https://pilotstatus.com.br/v1/numbers/{id}/purge', 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://pilotstatus.com.br/v1/numbers/{id}/purge",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "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://pilotstatus.com.br/v1/numbers/{id}/purge"

	req, _ := http.NewRequest("DELETE", url, nil)

	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))

}

require 'uri'
require 'net/http'

url = URI("https://pilotstatus.com.br/v1/numbers/{id}/purge")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "ok": true
}

{
  "error": "Unauthorized"
}

{
  "error": "Your workspace role does not allow this action (numbers:purge).",
  "code": "PERMISSION_DENIED"
}

{
  "error": "Not found"
}

{
  "error": "Too many requests"
}

Endpoints

Workspace

Purge number

Authorizations

Path Parameters

Response