Add a custom domain
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/custom-domains \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
hostname: 'vouchers.example-transit.example.com',
purpose: 'redemption-landing'
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/custom-domains', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/custom-domains"
payload = {
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/custom-domains")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"hostname\": \"vouchers.example-transit.example.com\",\n \"purpose\": \"redemption-landing\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/custom-domains"
payload := strings.NewReader("{\n \"hostname\": \"vouchers.example-transit.example.com\",\n \"purpose\": \"redemption-landing\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/custom-domains",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'hostname' => 'vouchers.example-transit.example.com',
'purpose' => 'redemption-landing'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 20017,
"resource": "custom-domain",
"partnerId": 1069,
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing",
"status": "pending-verification",
"sslStatus": null,
"verificationRecords": [
{
"type": "cname",
"name": "vouchers.example-transit.example.com",
"value": "customers.voucher.allride.io",
"purpose": "routing"
}
],
"verificationErrors": [],
"lastCheckedAt": null,
"activatedAt": null,
"isDefaultLanding": false,
"activeLinkCount": 0,
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/custom-domains/20017",
"type": "application/json"
}
}
}
}Custom domains
Add a custom domain
Adds a host name in pending-verification. Publish the CNAME to customers.voucher.allride.io and the TXT ownership and certificate records that appear on the domain shortly after (poll it). Consumer partners only. See Custom domains.
Required permissions: manage-domains · API keys: allowed
POST
/
partner
/
v1
/
custom-domains
Add a custom domain
curl --request POST \
--url https://api.voucher-staging.allride.io/partner/v1/custom-domains \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
hostname: 'vouchers.example-transit.example.com',
purpose: 'redemption-landing'
})
};
fetch('https://api.voucher-staging.allride.io/partner/v1/custom-domains', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voucher-staging.allride.io/partner/v1/custom-domains"
payload = {
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)HttpResponse<String> response = Unirest.post("https://api.voucher-staging.allride.io/partner/v1/custom-domains")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"hostname\": \"vouchers.example-transit.example.com\",\n \"purpose\": \"redemption-landing\"\n}")
.asString();package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.voucher-staging.allride.io/partner/v1/custom-domains"
payload := strings.NewReader("{\n \"hostname\": \"vouchers.example-transit.example.com\",\n \"purpose\": \"redemption-landing\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.voucher-staging.allride.io/partner/v1/custom-domains",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'hostname' => 'vouchers.example-transit.example.com',
'purpose' => 'redemption-landing'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"data": {
"id": 20017,
"resource": "custom-domain",
"partnerId": 1069,
"hostname": "vouchers.example-transit.example.com",
"purpose": "redemption-landing",
"status": "pending-verification",
"sslStatus": null,
"verificationRecords": [
{
"type": "cname",
"name": "vouchers.example-transit.example.com",
"value": "customers.voucher.allride.io",
"purpose": "routing"
}
],
"verificationErrors": [],
"lastCheckedAt": null,
"activatedAt": null,
"isDefaultLanding": false,
"activeLinkCount": 0,
"createdAt": "2026-10-22T10:00:00Z",
"updatedAt": "2026-10-22T10:00:00Z",
"_links": {
"self": {
"href": "https://api.voucher.allride.io/partner/v1/custom-domains/20017",
"type": "application/json"
}
}
}
}Authorizations
Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.
Headers
Optional key (1-255 printable ASCII characters, no spaces; a UUID is ideal) that makes this POST safe to retry: the same key with the same request replays the stored response for 24 hours. See Idempotency.
Required string length:
1 - 255Pattern:
^[\x21-\x7E]{1,255}$Body
application/json
Response
Created
Single-object envelope around a CustomDomain.
A custom host name for your Redemption Link landing pages.
Show child attributes
Show child attributes