POST /projects/{idOrName}/transfer-request
Initiates a project transfer request from one team to another.
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.
Users can also accept the project transfer request using the claim URL: https://vercel.com/claim-deployment?code=<code>&returnUrl=<returnUrl>.
The code parameter specifies the project transfer request code generated using this endpoint.
The returnUrl parameter redirects users to a specific page of the application if the claim URL is invalid or expired.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
idOrName |
String | Yes |
The ID or name of the project to transfer. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
teamId |
String | No |
The Team identifier to perform the request on behalf of. |
slug |
String | No |
The Team slug to perform the request on behalf of. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
callbackSecret |
String | No |
The secret to use to sign the webhook payload with HMAC-SHA256. |
callbackUrl |
String | No |
The URL to send a webhook to when the transfer is accepted. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.