DELETE

api

sms

numbers

:numberId

Remove SMS Number

curl --request DELETE \
  --url https://api.sequenzy.com/api/v1/sms/numbers/:numberId \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/sms/numbers/:numberId', 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://api.sequenzy.com/api/v1/sms/numbers/:numberId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.sequenzy.com/api/v1/sms/numbers/:numberId"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.sequenzy.com/api/v1/sms/numbers/:numberId")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "number": {
    "id": "num_abc123",
    "status": "released"
  },
  "message": "SMS number released."
}

{
  "error": "This number has already been released."
}

{
  "error": "Invalid API key"
}

{
  "error": "You have view-only access to this company. Contact the owner to request edit permissions."
}

{
  "error": "SMS number not found"
}

{
  "error": "A number purchase is still in progress. Wait for it to finish before releasing."
}

{
  "error": "Failed to release SMS number"
}

{
  "error": "Failed to release the number with the carrier."
}

Remove SMS Number

Releases a toll-free number back to the carrier via Telnyx and frees its slot under the workspace’s 100-number cap. This is irreversible - once released, the number cannot be reclaimed. Campaigns, sequence steps, and automations still pinned to the released number will skip their SMS sends until you point them at another verified number - an explicit “send from” choice is never silently swapped for a different number. Sends that never picked a specific number keep using the workspace default (oldest verified) number. Use this when a number’s verification was rejected and you want to purchase a different one, or when a brand’s number is no longer needed. This mutation requires the companies:manage scope.

Request

string

required

The SMS number ID, as returned by Get SMS Settings.

No request body. Pass X-Company-Id if your API key has access to multiple companies.

curl --request DELETE "https://api.sequenzy.com/api/v1/sms/numbers/num_abc123" \
  --header "Authorization: Bearer $SEQUENZY_API_KEY"

Responses

{
  "success": true,
  "number": {
    "id": "num_abc123",
    "status": "released"
  },
  "message": "SMS number released."
}

{
  "error": "This number has already been released."
}

{
  "error": "Invalid API key"
}

{
  "error": "You have view-only access to this company. Contact the owner to request edit permissions."
}

{
  "error": "SMS number not found"
}

{
  "error": "A number purchase is still in progress. Wait for it to finish before releasing."
}

{
  "error": "Failed to release SMS number"
}

{
  "error": "Failed to release the number with the carrier."
}

Remove SMS Number

curl --request DELETE \
  --url https://api.sequenzy.com/api/v1/sms/numbers/:numberId \
  --header 'Authorization: Bearer <token>'

const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/sms/numbers/:numberId', 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://api.sequenzy.com/api/v1/sms/numbers/:numberId",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.sequenzy.com/api/v1/sms/numbers/:numberId"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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://api.sequenzy.com/api/v1/sms/numbers/:numberId")

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

request = Net::HTTP::Delete.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "number": {
    "id": "num_abc123",
    "status": "released"
  },
  "message": "SMS number released."
}

{
  "error": "This number has already been released."
}

{
  "error": "Invalid API key"
}

{
  "error": "You have view-only access to this company. Contact the owner to request edit permissions."
}

{
  "error": "SMS number not found"
}

{
  "error": "A number purchase is still in progress. Wait for it to finish before releasing."
}

{
  "error": "Failed to release SMS number"
}

{
  "error": "Failed to release the number with the carrier."
}

​Remove SMS Number

​Request

​Responses

Remove SMS Number

Request

Responses