Create Branded Domain
Domains
Create Branded Domain
Add your own domain for short URLs
POST
Create Branded Domain
Register your own domain for branded short URLs. You can register distinct domains (e.g.,
mycompany.com) or specific subdomains (e.g., go.mycompany.com).
Why use branded domains?
- Full brand control: Your company domain on every link
- Trust: Users see your domain, increasing click-through rates
- Custom alias scoping: Same alias can exist on different branded domains
- Branded Subdomains: You can explicitly register branded subdomains like
go.mycompany.comjust like you would a root domain. - Professional appearance: Enterprise-grade link management
Body Parameters
The domain name to register.Requirements:
- 3-255 characters
- Valid domain format
- Cannot use
jmpy.meor subdomains of it - You must own or control this domain
mycompany.com, go.mycompany.com, links.mysite.orgOptional display name for the domain.Constraints: 1-100 characters
Optional description for the domain.Constraints: Max 500 characters
Whether this is a dedicated root domain (requires additional DNS setup).
Response
Unique identifier for the branded domain (UUID).
The registered domain name.
Whether the domain is verified via DNS.
DNS verification details including:
cname_target: The CNAME record targettxt_record: The TXT verification recordinstructions: Step-by-step verification guide
ISO 8601 timestamp of creation.
Request Examples
- cURL
- Node.js
- TypeScript
- Python
- PHP
- Go
- Java
Response Examples
- 201 Created
- 409 Domain Exists
- 400 Invalid Domain
- 403 Plan Limit
- 403 Feature Disabled
DNS Setup Guide
Add CNAME Record
Point your subdomain to Jmpy.me:
For root domains, use an ALIAS or ANAME record if your DNS provider supports it.
| Type | Name | Value |
|---|---|---|
| CNAME | go | redirect.jmpy.me |
Add TXT Verification Record
Prove domain ownership:
The exact value is provided in the API response.
| Type | Name | Value |
|---|---|---|
| TXT | _jmpy.go | jmpy-verify=abc123xyz789 |
Wait for DNS Propagation
DNS changes can take up to 48 hours to propagate globally.
You can check propagation at whatsmydns.net.
Verify the Domain
Call the Verify Domain endpoint to complete setup.
Related Endpoints
Verify Domain
Complete domain verification after DNS setup
List Domains
View all your registered domains
Create Short URL
Create links on your branded domain
Delete Domain
Remove a registered domain