Add an existing domain to the Vercel platform

APIs & SDKs

POSThttps://api.vercel.com/v7/domains

This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Note: This endpoint is no longer used for initiating domain transfers from external registrars to Vercel. For this, please use the endpoint Transfer-in a domain.

https://api.vercel.com/v7/domains

const response = await fetch('https://api.vercel.com/v7/domains?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "method": "add",
    "name": "example.com",
    "cdnEnabled": "true",
    "zone": "true"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "domain": {
    "boughtAt": "1613602938882",
    "createdAt": "1613602938882",
    "creator": {
      "customerId": "example_id",
      "email": "user@example.com",
      "id": "icfg_1234567890",
      "isDomainReseller": "false",
      "username": "string"
    },
    "customNameservers": [],
    "echMode": "auto",
    "expiresAt": "123",
    "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
    "intendedNameservers": [],
    "name": "example.com",
    "nameservers": [],
    "renew": "true",
    "serviceType": "zeit.world",
    "teamId": "example_id",
    "transferredAt": "1613602938882",
    "transferStartedAt": "1613602938882",
    "userId": "example_id",
    "verified": "true"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

methodstringOptional

The domain operation to perform.

namestringRequired

The domain name you want to add.

cdnEnabledbooleanOptional

Whether the domain has the Vercel CDN enabled or not.

zonebooleanOptional

Whether to create a DNS zone on Vercel. Set true if using Vercel nameservers.

Response

200Success

domainobjectRequired

Errors

400One of the provided values in the request body is invalid.

401The request is not authorized.

402The account is missing a payment so payment method must be updated

403You do not have permission to access this resource.

404Error

409The domain is not allowed to be used

410Error

Cross-link map: Add an existing domain to the Vercel platform (/docs/rest-api/domains/add-an-existing-domain-to-the-vercel-platform)

From the Vercel docs graph (built 2026-10-07T05:48:34.144Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Add a domain to a project — POST /v10/projects/{idOrName}/domains — Add a domain to the project by passing its domain name and by specifying the pro
Transfer-in a domain — POST /v1/registrar/domains/{domain}/transfer — Transfer a domain in from another registrar
Update or move apex domain — PATCH /v3/domains/{domain} — Update or move apex domain. Note: This endpoint is no longer used for updating auto-renew o
List all the domains — GET /v5/domains — Retrieves a list of domains registered for the authenticated user or team. By default it returns the l
Renew a domain — POST /v1/registrar/domains/{domain}/renew — Renew a domain

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (2)

By site: vercel-docs (2)

Multi-tenant Reference — Reference for the Vercel domain API, error codes, troubleshooting, and FAQ for multi-tenant platforms.
Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v7/domains

const response = await fetch('https://api.vercel.com/v7/domains?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "method": "add",
    "name": "example.com",
    "cdnEnabled": "true",
    "zone": "true"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "domain": {
    "boughtAt": "1613602938882",
    "createdAt": "1613602938882",
    "creator": {
      "customerId": "example_id",
      "email": "user@example.com",
      "id": "icfg_1234567890",
      "isDomainReseller": "false",
      "username": "string"
    },
    "customNameservers": [],
    "echMode": "auto",
    "expiresAt": "123",
    "id": "EmTbe5CEJyTk2yVAHBUWy4A3sRusca3GCwRjTC1bpeVnt1",
    "intendedNameservers": [],
    "name": "example.com",
    "nameservers": [],
    "renew": "true",
    "serviceType": "zeit.world",
    "teamId": "example_id",
    "transferredAt": "1613602938882",
    "transferStartedAt": "1613602938882",
    "userId": "example_id",
    "verified": "true"
  }
}

OpenAPI Specification