Skip to content
Docs

Create Resources Transfer Request

Optional
POST/v1/installations/{installationId}/resource-transfer-requests
Prepares to transfer resources from the current installation to a new one. The target installation to transfer resources to will not be known until the verify & accept steps.
Needed if your integration supports transferring resources between Vercel teams. Vercel calls this endpoint when a user initiates a resource transfer. Update ownership records on your side.
/v1/installations/{installationId}/resource-transfer-requests
const response = await fetch('/v1/installations/installationId/resource-transfer-requests', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "resourceIds": [],
    "expiresAt": "123"
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "providerClaimId": "example_id"
}
Errors
{
  "error": {
    "code": "validation_error",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    },
    "fields": [
      {
        "key": "string",
        "message": "string"
      }
    ]
  }
}

Authentication

AuthorizationSystem Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired

Header parameters

X-Vercel-AuthstringOptional
The auth style used in the request (system, user, etc)
Idempotency-KeystringOptional
A unique key to identify a request across multiple retries

Request

This endpoint expects an object.

resourceIdsarrayRequired
The IDs of the resources owned by the source installation that will be transferred to the target installation.
expiresAtnumberRequired
The timestamp in milliseconds when the transfer claim expires. After this time, the transfer cannot be claimed.

Response

200Claim created successfully
providerClaimIdstringRequired
The provider-specific claim ID for the resource transfer.

Errors

400Input has failed validation
errorobjectRequired
403Operation failed because the authentication is not allowed to perform this operation
errorobjectRequired
409Operation failed because of a conflict with the current state of the resource
errorobjectRequired
422Operation is well-formed, but cannot be executed due to semantic errors
errorobjectRequired
Create Resources Transfer Request | Partner API