Skip to main content
POST
/
projects
/
{idOrName}
/
transfer-request
createProjectTransferRequest
import { Vercel } from "@vercel/sdk";

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

async function run() {
  const result = await vercel.projects.createProjectTransferRequest({
    idOrName: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();
{
  "code": "f99cc49a-602e-4786-a748-762dfb205880"
}

Authorizations

​
Authorization
string
header
required

Default authentication mechanism

Path Parameters

​
idOrName
string
required

The ID or name of the project to transfer.

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
​
callbackUrl
string

The URL to send a webhook to when the transfer is accepted.

​
callbackSecret
string

The secret to use to sign the webhook payload with HMAC-SHA256.

Response

The project transfer request has been initiated successfully.

​
code
string
required

Code that can be used to accept the project transfer request.

Example:

"f99cc49a-602e-4786-a748-762dfb205880"