Update or move apex domain | Vercel REST API

APIs & SDKs

Update or move apex domain

PATCHhttps://api.vercel.com/v3/domains/{domain}

Update or move apex domain. Note: This endpoint is no longer used for updating auto-renew or nameservers. For this, please use the endpoints Update auto-renew for a domain and Update nameservers for a domain.

https://api.vercel.com/v3/domains/{domain}

const response = await fetch('https://api.vercel.com/v3/domains/domain?teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "op": "update",
    "renew": "true",
    "customNameservers": [],
    "zone": "true",
    "echMode": "auto"
  }),
});

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

Response

{
  "moved": "false"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

domainstringRequired

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

opstringOptional

renewbooleanOptionalDeprecated

This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/auto-renew instead.

customNameserversarrayOptionalDeprecated

This field is deprecated. Please use PATCH /v1/registrar/domains/{domainName}/nameservers instead.

zonebooleanOptional

Specifies whether this is a DNS zone that intends to use Vercel's nameservers.

echModestringOptional

Encrypted Client Hello enrollment. 'auto' leaves it to Vercel, 'disabled' never enrolls and opts out of automatic enrollment.

Response

200Success

movedbooleanRequired

Errors

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

401The request is not authorized.

403You do not have permission to access this resource.

404Error

409Error

410Error

500Error

Cross-link map: Update or move apex domain (/docs/rest-api/domains/update-or-move-apex-domain)

From the Vercel docs graph (built 2026-10-12T05:34:10.371Z), 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 an existing domain to the Vercel platform — POST /v7/domains — This endpoint is used for adding a new apex domain name with Vercel for the authenticating user. Note
Update auto-renew for a domain — PATCH /v1/registrar/domains/{domain}/auto-renew — Update the auto-renew setting for a domain
Update a project domain — PATCH /v9/projects/{idOrName}/domains/{domain} — Update a project domain's configuration, including the name, git branch
Move a project domain — POST /v1/projects/{idOrName}/domains/{domain}/move — Move one project's domain to another project. Also allows the move
Update nameservers for a domain — PATCH /v1/registrar/domains/{domain}/nameservers — Update the nameservers for a domain. Pass an empty array to use Verce

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 (1)

By site: vercel-docs (1)

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

https://api.vercel.com/v3/domains/{domain}

const response = await fetch('https://api.vercel.com/v3/domains/domain?teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "op": "update",
    "renew": "true",
    "customNameservers": [],
    "zone": "true",
    "echMode": "auto"
  }),
});

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

Response

{
  "moved": "false"
}

OpenAPI Specification