curl --request POST \
--url https://api.bizzyco.ai/v1/domains/{id}/subdomains \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "<string>",
"purpose": "general"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: '<string>', purpose: 'general'})
};
fetch('https://api.bizzyco.ai/v1/domains/{id}/subdomains', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.bizzyco.ai/v1/domains/{id}/subdomains"
payload = {
"domain": "<string>",
"purpose": "general"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bizzyco.ai/v1/domains/{id}/subdomains"
payload := strings.NewReader("{\n \"domain\": \"<string>\",\n \"purpose\": \"general\"\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))
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"domain": "<string>",
"source": "registered",
"status": "active",
"kind": "apex",
"parentDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "general",
"capabilities": {
"dns": true,
"email": true,
"registration": true,
"renewal": true
},
"verification": {
"status": "pending",
"instruction": {
"type": "TXT",
"name": "<string>",
"value": "<string>"
},
"attempts": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z"
},
"registration": {
"registered": true,
"state": "<string>",
"registeredAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"autoRenew": true,
"whoisPrivacy": true,
"transferLock": true,
"periodYears": 123,
"registrantVerificationDeadline": "2023-11-07T05:31:56Z"
},
"email": {
"domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"source": "registered",
"managed": true,
"resendStatus": "none",
"readiness": "ready",
"failureReason": "provider",
"drift": {
"brokenAt": "2023-11-07T05:31:56Z",
"kinds": [
"SPF"
]
},
"fromEmail": "<string>",
"records": [
{
"kind": "SPF",
"state": "verified",
"managed": true,
"required": true,
"name": "<string>",
"type": "TXT",
"value": "<string>",
"ttl": "<string>",
"priority": 123,
"inheritedFrom": "<string>",
"effectivePolicy": "none"
}
]
}
},
"meta": {
"pagination": {
"limit": 123,
"offset": 123,
"hasMore": true,
"total": 123
}
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}Create subdomain
Add a sending subdomain under a verified apex domain. domain is the full name and must sit exactly one label under the parent (mail.acme.com under acme.com). The subdomain inherits the parent’s verification — no TXT challenge is issued and it is active at once — and never holds a registration or DNS zone of its own, so capabilities.dns reports the parent’s. purpose defaults to general (sends and receives); transactional and marketing are sending-only. Refused with 409 when the parent is itself a subdomain (DOMAIN_NOT_APEX), is not yet verified (DOMAIN_NOT_VERIFIED), has a transfer to another registrar under way (REGISTERED_DOMAIN_TRANSFER_IN_FLIGHT), or the name is already in the organization (DOMAIN_ALREADY_EXISTS); with 400 and code SUBDOMAIN_NOT_UNDER_PARENT when the name is not exactly one label under the parent; and with 404 when the parent is not in the organization.
curl --request POST \
--url https://api.bizzyco.ai/v1/domains/{id}/subdomains \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"domain": "<string>",
"purpose": "general"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: '<string>', purpose: 'general'})
};
fetch('https://api.bizzyco.ai/v1/domains/{id}/subdomains', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.bizzyco.ai/v1/domains/{id}/subdomains"
payload = {
"domain": "<string>",
"purpose": "general"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bizzyco.ai/v1/domains/{id}/subdomains"
payload := strings.NewReader("{\n \"domain\": \"<string>\",\n \"purpose\": \"general\"\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))
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"domain": "<string>",
"source": "registered",
"status": "active",
"kind": "apex",
"parentDomainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"purpose": "general",
"capabilities": {
"dns": true,
"email": true,
"registration": true,
"renewal": true
},
"verification": {
"status": "pending",
"instruction": {
"type": "TXT",
"name": "<string>",
"value": "<string>"
},
"attempts": 123,
"verifiedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z"
},
"registration": {
"registered": true,
"state": "<string>",
"registeredAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"autoRenew": true,
"whoisPrivacy": true,
"transferLock": true,
"periodYears": 123,
"registrantVerificationDeadline": "2023-11-07T05:31:56Z"
},
"email": {
"domainId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"source": "registered",
"managed": true,
"resendStatus": "none",
"readiness": "ready",
"failureReason": "provider",
"drift": {
"brokenAt": "2023-11-07T05:31:56Z",
"kinds": [
"SPF"
]
},
"fromEmail": "<string>",
"records": [
{
"kind": "SPF",
"state": "verified",
"managed": true,
"required": true,
"name": "<string>",
"type": "TXT",
"value": "<string>",
"ttl": "<string>",
"priority": 123,
"inheritedFrom": "<string>",
"effectivePolicy": "none"
}
]
}
},
"meta": {
"pagination": {
"limit": 123,
"offset": 123,
"hasMore": true,
"total": 123
}
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>"
}
}Authorizations
API key authentication via Bearer token
Headers
Key that makes this request safe to retry. Reuse the same value when retrying a request that may already have succeeded — the original response is replayed with an Idempotency-Replay: true header. Use a new value for a new operation.
1 - 255"9f8c2b1a-4d3e-4a6b-8c1d-2e3f4a5b6c7d"
Path Parameters
Domain UUID
Body
The full name, exactly one label under the parent — mail.example.com under example.com.
1 - 253^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?(\.[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)*$Defaults to general (sends and receives). transactional and marketing are sending-only.
general, transactional, marketing