api.botsubscription.com

GET/v1/endpoint

AuthenticationBearer

Token

Stays in this tab. Required for this endpoint — the value below is what gets sent.

Path parameters0

Query parameters0

BodyJSON

Mock

curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Configure a Custom Hostname for a Subscription Bot Project

Set the custom hostname for a Discord subscription bot or Telegram subscription bot project. Features that use custom_hostname explain their own hostname requirements in their respective API documentation.

PATCH/v2/projects/{project_id}/settings/custom_hostname

Authorization

Bearer TokenRequired

The token must have the settings:write scope.

Path Parameters

project_idstringrequired

The unique identifier of the project.

Request Body

valuestringrequired

One exact, bare hostname. Wildcards are not supported. Do not include a scheme, port, path, query, or trailing slash.

The value represents exactly one hostname. Setting example.com does not include www.example.com, subdomain.example.com, or any other subdomain. Configure the exact hostname required by the feature using this setting.

Valid:

example.com

Invalid:

https://example.com/
example.com/path
*.example.com

This request only sets the project's custom_hostname value. It does not configure CORS, DNS, API hosting, or browser access. If the value conflicts with an existing verified hostname or origin, the API returns a conflict and does not assign it to the project.

curl -X PATCH "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/settings/custom_hostname" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "example.com"
  }'

const projectId = 'YOUR_PROJECT_ID';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${projectId}/settings/custom_hostname`, {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ value: 'example.com' })
});
// 204 No Content on success

import requests
 
project_id = 'YOUR_PROJECT_ID'
response = requests.patch(
    f'https://api.botsubscription.com/v2/projects/{project_id}/settings/custom_hostname',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={'value': 'example.com'}
)
# 204 No Content on success

$project_id = 'YOUR_PROJECT_ID';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/settings/custom_hostname");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer YOUR_TOKEN',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'value' => 'example.com'
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
// 204 No Content on success

Custom hostname updatedapplication/json

No response body is returned on success.

Hostname conflictapplication/json

{
  "ok": false,
  "request_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "method": "PATCH",
  "path": "/v2/projects/YOUR_PROJECT_ID/settings/custom_hostname",
  "code": 409,
  "error": {
    "error_code": "CONFLICT",
    "message": "Hostname conflicts with an existing verified hostname or origin"
  }
}

Last updated: August 29, 2026