Accept project transfer request

APIs & SDKs

PUT/__remote/api.vercel.com/projects/transfer-request/{code}

Accept a project transfer request initated by another team.
The code is generated using the POST /projects/:idOrName/transfer-request endpoint.

/__remote/api.vercel.com/projects/transfer-request/{code}

const response = await fetch('/__remote/api.vercel.com/projects/transfer-request/code?teamId=string&slug=string', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "newProjectName": "a-project-name",
    "paidFeatures": {
      "concurrentBuilds": "123",
      "passwordProtection": "true",
      "previewDeploymentSuffix": "true"
    },
    "acceptedPolicies": "value"
  }),
});

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

Response

{
  "partnerCalls": [
    {
      "installationId": "example_id",
      "resourceIds": [],
      "result": {
        "code": "string",
        "error": "value",
        "status": "errored"
      }
    }
  ],
  "projectName": "Example Name",
  "resourceTransferErrors": [
    "value"
  ],
  "transferredStoreIds": []
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

codestringRequired

The code of the project transfer request.

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

newProjectNamestringOptional

The desired name for the project

paidFeaturesobjectOptional

acceptedPoliciesobjectOptional

Response

202The project has been transferred successfully.

partnerCallsarrayRequired

projectNamestringRequired

resourceTransferErrorsarrayRequired

transferredStoreIdsarrayRequired

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

410Error

422Error

/__remote/api.vercel.com/projects/transfer-request/{code}

const response = await fetch('/__remote/api.vercel.com/projects/transfer-request/code?teamId=string&slug=string', {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "newProjectName": "a-project-name",
    "paidFeatures": {
      "concurrentBuilds": "123",
      "passwordProtection": "true",
      "previewDeploymentSuffix": "true"
    },
    "acceptedPolicies": "value"
  }),
});

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

Response

{
  "partnerCalls": [
    {
      "installationId": "example_id",
      "resourceIds": [],
      "result": {
        "code": "string",
        "error": "value",
        "status": "errored"
      }
    }
  ],
  "projectName": "Example Name",
  "resourceTransferErrors": [
    "value"
  ],
  "transferredStoreIds": []
}

OpenAPI Specification