POST
https://jmpy.me/api/v1
/
domains
/
subdomains
Create Subdomain
curl --request POST \
  --url https://jmpy.me/api/v1/domains/subdomains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "subdomain": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "subdomain": "<string>",
  "full_domain": "<string>",
  "is_verified": true,
  "created_at": "<string>"
}
Register a new subdomain under jmpy.me for your short URLs. Once registered and verified, you can create short URLs like yourname.jmpy.me/link.
Why use subdomains?
  • Brand recognition: Use your company or project name
  • Organization: Group links by purpose (e.g., marketing.jmpy.me, docs.jmpy.me)
  • Custom alias scoping: The same alias can exist on different subdomains

Body Parameters

subdomain
string
required
The subdomain name to register.Requirements:
  • 3-63 characters
  • Alphanumeric and dashes (-) only
  • Cannot start or end with a dash
  • Must be unique and not already registered by another user
Reserved subdomains: www, api, admin, app, mail, ftp, blog, shop, store, support, help, docs, dev, test, staging
name
string
Optional display name for the subdomain.Constraints: 1-100 charactersExample: Acme Corp Links
description
string
Optional description for the subdomain.Constraints: Max 500 characters

Response

id
string
Unique identifier for the subdomain (UUID).
subdomain
string
The registered subdomain name.
full_domain
string
The complete domain (e.g., acme.jmpy.me).
is_verified
boolean
Whether the subdomain is verified and ready for use.
created_at
string
ISO 8601 timestamp of creation.

Request Examples

curl -X POST "https://jmpy.me/api/v1/domains/subdomains" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subdomain": "acme",
    "name": "Acme Corp Links",
    "description": "Marketing team short links"
  }'

Response Examples

{
  "success": true,
  "data": {
    "id": "880e8400-e29b-41d4-a716-446655440000",
    "subdomain": "acme",
    "full_domain": "acme.jmpy.me",
    "name": "Acme Corp Links",
    "description": "Marketing team short links",
    "is_verified": true,
    "url_count": 0,
    "created_at": "2024-01-15T10:30:00.000Z"
  }
}

Next Steps

Example Usage

After creating a subdomain, you can create short URLs using it:
curl -X POST "https://jmpy.me/api/v1/short-urls" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/page",
    "url_type": "subdomain",
    "subdomain": "acme",
    "custom_alias": "my-link"
  }'
This creates: https://acme.jmpy.me/my-link