v13

OpenAPI 3.0.32026-07-31359869.4 MB

projects

Create project transfer request

Initiates a project transfer request from one team to another. <br/> Returns a code that remains valid for 24 hours and can be used to accept the transfer request by another team using the PUT /projects/transfer-request/:code endpoint. <br/> Users can also accept the project transfer request using the claim URL: https://vercel.com/claim-deployment?code=<code>&returnUrl=<returnUrl>. <br/> The code parameter specifies the project transfer request code generated using this endpoint. <br/> The returnUrl parameter redirects users to a specific page of the application if the claim URL is invalid or expired.

post/projects/{idOrName}/transfer-request

Path parameters

idOrNamestring required

The ID or name of the project to transfer.

Query parameters

teamIdstring

Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring

Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

callbackUrlstring

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

callbackSecretstring

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

Response

The project transfer request has been initiated successfully.

codestring required

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

Example response

{
  "code": "f99cc49a-602e-4786-a748-762dfb205880"
}