PATCH
/
v3
/
domains
/
{domain}
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.domains.patchDomain({
    domain: "tight-secrecy.info",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      op: "update",
    },
  });

  // Handle the result
  console.log(result);
}

run();
{
  "moved": true
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

domain
string
required

Query Parameters

teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json

update

op
string
Example:

"update"

renew
boolean

Specifies whether domain should be renewed.

customNameservers
string[]

The custom nameservers for this project.

zone
boolean

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

Response

200
application/json
moved
boolean
required