Update domain settings
curl --request PATCH \
--url https://api.h0p.co/domain/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"indexUrl": "https://example.com",
"fallbackUrl": "https://example.com/404",
"qrCode": {
"options": {
"data": "",
"width": 300,
"dotsOptions": {
"color": "#000000"
}
},
"imageId": null
}
}
'import requests
url = "https://api.h0p.co/domain/{id}"
payload = {
"indexUrl": "https://example.com",
"fallbackUrl": "https://example.com/404",
"qrCode": {
"options": {
"data": "",
"width": 300,
"dotsOptions": { "color": "#000000" }
},
"imageId": None
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
indexUrl: 'https://example.com',
fallbackUrl: 'https://example.com/404',
qrCode: {
options: {data: '', width: 300, dotsOptions: {color: '#000000'}},
imageId: null
}
})
};
fetch('https://api.h0p.co/domain/{id}', 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.h0p.co/domain/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'indexUrl' => 'https://example.com',
'fallbackUrl' => 'https://example.com/404',
'qrCode' => [
'options' => [
'data' => '',
'width' => 300,
'dotsOptions' => [
'color' => '#000000'
]
],
'imageId' => null
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.h0p.co/domain/{id}"
payload := strings.NewReader("{\n \"indexUrl\": \"https://example.com\",\n \"fallbackUrl\": \"https://example.com/404\",\n \"qrCode\": {\n \"options\": {\n \"data\": \"\",\n \"width\": 300,\n \"dotsOptions\": {\n \"color\": \"#000000\"\n }\n },\n \"imageId\": null\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.h0p.co/domain/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"indexUrl\": \"https://example.com\",\n \"fallbackUrl\": \"https://example.com/404\",\n \"qrCode\": {\n \"options\": {\n \"data\": \"\",\n \"width\": 300,\n \"dotsOptions\": {\n \"color\": \"#000000\"\n }\n },\n \"imageId\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.h0p.co/domain/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"indexUrl\": \"https://example.com\",\n \"fallbackUrl\": \"https://example.com/404\",\n \"qrCode\": {\n \"options\": {\n \"data\": \"\",\n \"width\": 300,\n \"dotsOptions\": {\n \"color\": \"#000000\"\n }\n },\n \"imageId\": null\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-16T14:20:00Z",
"organizationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"domain": "links.example.com",
"isActive": true,
"lastCheckedAt": "2024-01-15T10:35:00Z",
"isVerified": true,
"txtRecord": "_vercel=1234567890abcdef",
"isPrimary": true,
"qrCodeId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"fallbackUrl": "https://example.com/404",
"appleAppSiteAssociation": {},
"androidAssetLinks": {},
"qrCode": {
"options": {
"data": "https://example.com/abc123",
"type": "svg",
"width": 300,
"height": 300,
"margin": 4,
"image": "https://example.com/logo.png",
"imageOptions": {
"hideBackgroundDots": true,
"imageSize": 0.4,
"crossOrigin": "anonymous",
"margin": 10
},
"dotsOptions": {
"type": "rounded",
"color": "#000000",
"gradient": {
"type": "linear",
"colorStops": [
{
"offset": 0,
"color": "#3B82F6"
},
{
"offset": 1,
"color": "#8B5CF6"
}
],
"rotation": 45
},
"roundSize": true
},
"cornersSquareOptions": {
"type": "square",
"color": "#3B82F6",
"gradient": {
"type": "linear",
"colorStops": [
{
"offset": 0,
"color": "#3B82F6"
},
{
"offset": 1,
"color": "#8B5CF6"
}
],
"rotation": 45
}
},
"cornersDotOptions": {
"type": "dot",
"color": "#8B5CF6",
"gradient": {
"type": "linear",
"colorStops": [
{
"offset": 0,
"color": "#3B82F6"
},
{
"offset": 1,
"color": "#8B5CF6"
}
],
"rotation": 45
}
},
"backgroundOptions": {
"round": 0.1,
"color": "#FFFFFF"
}
},
"imageId": "01933eb8-541f-7000-a9f4-e4eee80ff04e"
}
}{
"code": "PLAN_LIMIT_REACHED",
"message": "You have reached the maximum number of domains for your plan."
}{
"code": "NOT_FOUND"
}Domain
Update domain settings
Update domain URLs (index/fallback), deep linking (AASA/Android), and QR code template. Partial updates supported.
PATCH
/
domain
/
{id}
Update domain settings
curl --request PATCH \
--url https://api.h0p.co/domain/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"indexUrl": "https://example.com",
"fallbackUrl": "https://example.com/404",
"qrCode": {
"options": {
"data": "",
"width": 300,
"dotsOptions": {
"color": "#000000"
}
},
"imageId": null
}
}
'import requests
url = "https://api.h0p.co/domain/{id}"
payload = {
"indexUrl": "https://example.com",
"fallbackUrl": "https://example.com/404",
"qrCode": {
"options": {
"data": "",
"width": 300,
"dotsOptions": { "color": "#000000" }
},
"imageId": None
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
indexUrl: 'https://example.com',
fallbackUrl: 'https://example.com/404',
qrCode: {
options: {data: '', width: 300, dotsOptions: {color: '#000000'}},
imageId: null
}
})
};
fetch('https://api.h0p.co/domain/{id}', 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.h0p.co/domain/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'indexUrl' => 'https://example.com',
'fallbackUrl' => 'https://example.com/404',
'qrCode' => [
'options' => [
'data' => '',
'width' => 300,
'dotsOptions' => [
'color' => '#000000'
]
],
'imageId' => null
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.h0p.co/domain/{id}"
payload := strings.NewReader("{\n \"indexUrl\": \"https://example.com\",\n \"fallbackUrl\": \"https://example.com/404\",\n \"qrCode\": {\n \"options\": {\n \"data\": \"\",\n \"width\": 300,\n \"dotsOptions\": {\n \"color\": \"#000000\"\n }\n },\n \"imageId\": null\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.h0p.co/domain/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"indexUrl\": \"https://example.com\",\n \"fallbackUrl\": \"https://example.com/404\",\n \"qrCode\": {\n \"options\": {\n \"data\": \"\",\n \"width\": 300,\n \"dotsOptions\": {\n \"color\": \"#000000\"\n }\n },\n \"imageId\": null\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.h0p.co/domain/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"indexUrl\": \"https://example.com\",\n \"fallbackUrl\": \"https://example.com/404\",\n \"qrCode\": {\n \"options\": {\n \"data\": \"\",\n \"width\": 300,\n \"dotsOptions\": {\n \"color\": \"#000000\"\n }\n },\n \"imageId\": null\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-16T14:20:00Z",
"organizationId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"domain": "links.example.com",
"isActive": true,
"lastCheckedAt": "2024-01-15T10:35:00Z",
"isVerified": true,
"txtRecord": "_vercel=1234567890abcdef",
"isPrimary": true,
"qrCodeId": "01933eb8-541f-7000-a9f4-e4eee80ff04e",
"fallbackUrl": "https://example.com/404",
"appleAppSiteAssociation": {},
"androidAssetLinks": {},
"qrCode": {
"options": {
"data": "https://example.com/abc123",
"type": "svg",
"width": 300,
"height": 300,
"margin": 4,
"image": "https://example.com/logo.png",
"imageOptions": {
"hideBackgroundDots": true,
"imageSize": 0.4,
"crossOrigin": "anonymous",
"margin": 10
},
"dotsOptions": {
"type": "rounded",
"color": "#000000",
"gradient": {
"type": "linear",
"colorStops": [
{
"offset": 0,
"color": "#3B82F6"
},
{
"offset": 1,
"color": "#8B5CF6"
}
],
"rotation": 45
},
"roundSize": true
},
"cornersSquareOptions": {
"type": "square",
"color": "#3B82F6",
"gradient": {
"type": "linear",
"colorStops": [
{
"offset": 0,
"color": "#3B82F6"
},
{
"offset": 1,
"color": "#8B5CF6"
}
],
"rotation": 45
}
},
"cornersDotOptions": {
"type": "dot",
"color": "#8B5CF6",
"gradient": {
"type": "linear",
"colorStops": [
{
"offset": 0,
"color": "#3B82F6"
},
{
"offset": 1,
"color": "#8B5CF6"
}
],
"rotation": 45
}
},
"backgroundOptions": {
"round": 0.1,
"color": "#FFFFFF"
}
},
"imageId": "01933eb8-541f-7000-a9f4-e4eee80ff04e"
}
}{
"code": "PLAN_LIMIT_REACHED",
"message": "You have reached the maximum number of domains for your plan."
}{
"code": "NOT_FOUND"
}Authorizations
API Key authentication for programmatic access.
How to use:
- Create an API key from your dashboard settings
- Include the key in the
x-api-keyheader with each request - API keys have granular permissions (domains, shortLinks, files, stats, apiKeys)
Example:
curl -H "x-api-key: your-api-key-here" https://api.h0p.co/short-link/list
Types of API keys:
- User keys: Linked to your user account (one per organization)
- Bot keys: Autonomous machine users (one per organization)
Security notes:
- Keep your API keys secure and never commit them to version control
- API keys cannot access authentication endpoints (/auth/*)
- Keys can be revoked at any time from the dashboard
Path Parameters
Unique identifier in UUID v7 format
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Body
application/json
Domain settings to update (partial update supported)
Domain update request
Fallback URL for invalid/deleted short links
Example:
"https://example.com/404"
Default QR code template for all links on this domain
Show child attributes
Show child attributes
URL to redirect to when accessing domain root
Example:
"https://example.com"
Apple App Site Association JSON for deep linking
Show child attributes
Show child attributes
Example:
{
"applinks": {
"apps": [],
"details": [
{
"appID": "TEAMID.com.example.app",
"paths": ["*"]
}
]
}
}
Android Asset Links JSON for deep linking
Show child attributes
Show child attributes
Example:
[
{
"relation": [
"delegate_permission/common.handle_all_urls"
],
"target": {
"namespace": "android_app",
"package_name": "com.example.app",
"sha256_cert_fingerprints": [
"AA:BB:CC:DD:EE:FF:00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF"
]
}
}
]
Response
Domain settings updated successfully
Complete domain object with all fields
Domain UUID
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Creation timestamp
Example:
"2024-01-15T10:30:00Z"
Last update timestamp
Example:
"2024-01-16T14:20:00Z"
Organization UUID
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Domain name
Example:
"links.example.com"
Whether domain is active
Example:
true
Last DNS check timestamp
Example:
"2024-01-15T10:35:00Z"
Complete verification status
Example:
true
TXT record value for DNS verification
Example:
"_vercel=1234567890abcdef"
Primary domain status
Example:
true
QR code template UUID
Example:
"01933eb8-541f-7000-a9f4-e4eee80ff04e"
Fallback URL for 404s
Example:
"https://example.com/404"
Apple Universal Links config
Show child attributes
Show child attributes
Android App Links config
Show child attributes
Show child attributes
Default QR code template
Show child attributes
Show child attributes