Delete a branded domain.
You cannot delete a domain if it has active short URLs unless force=true is used.
Path Parameters
The UUID of the branded domain.
Query Parameters
If true, deletes the domain even if it has associated short URLs (URLs will also be deleted).
Request Examples
cURL
Node.js
TypeScript
Python
PHP
Go
Java
curl -X DELETE "https://jmpy.me/api/v1/domains/branded/YOUR_DOMAIN_ID?force=false" \
-H "Authorization: Bearer YOUR_API_KEY"
const fetch = require ( 'node-fetch' );
const response = await fetch ( 'https://jmpy.me/api/v1/domains/branded/YOUR_DOMAIN_ID?force=false' , {
method: 'DELETE' ,
headers: { 'Authorization' : 'Bearer YOUR_API_KEY' }
});
const data = await response . json ();
console . log ( data );
import axios from 'axios' ;
const response = await axios . delete (
'https://jmpy.me/api/v1/domains/branded/YOUR_DOMAIN_ID' ,
{
params: { force: false },
headers: { 'Authorization' : 'Bearer YOUR_API_KEY' }
}
);
console . log ( response . data );
import requests
response = requests.delete(
'https://jmpy.me/api/v1/domains/branded/YOUR_DOMAIN_ID' ,
params = { 'force' : 'false' },
headers = { 'Authorization' : 'Bearer YOUR_API_KEY' }
)
print (response.json())
<? php
$client = new GuzzleHttp\ Client ();
$response = $client -> request ( ' DELETE ' , 'https://jmpy.me/api/v1/domains/branded/YOUR_DOMAIN_ID' , [
'query' => [ 'force' => 'false' ],
'headers' => [
'Authorization' => 'Bearer YOUR_API_KEY'
]
]);
?>
package main
import (
" net/http "
)
func main () {
url := "https://jmpy.me/api/v1/domains/branded/YOUR_DOMAIN_ID?force=false"
req , _ := http . NewRequest ( "DELETE" , url , nil )
req . Header . Add ( "Authorization" , "Bearer YOUR_API_KEY" )
http . DefaultClient . Do ( req )
}
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.URI;
import java.net.http.HttpResponse;
HttpClient client = HttpClient . newHttpClient ();
HttpRequest request = HttpRequest . newBuilder ()
. uri ( URI . create ( "https://jmpy.me/api/v1/domains/branded/YOUR_DOMAIN_ID?force=false" ))
. header ( "Authorization" , "Bearer YOUR_API_KEY" )
. DELETE ()
. build ();
client . send (request, HttpResponse . BodyHandlers . ofString ());
Response Examples
{
"success" : true ,
"data" : {
"message" : "Branded domain deleted successfully"
}
}
{
"success" : false ,
"error" : {
"code" : "CONFLICT" ,
"message" : "Cannot delete domain. It has 5 active short URLs. Please delete or transfer the URLs first."
}
}
List Domains View your remaining registered domains
Create Domain Register a new branded domain