Skip to content
Docs

Delete Installation

Required
DEL/v1/installations/{installationId}
Deletes the Installation. The final deletion is postponed for 24 hours to allow for sending of final invoices. You can request immediate deletion by specifying {finalized:true} in the response.
Vercel calls this endpoint when a customer uninstalls your integration and postpones deletion for 24 hours to allow final invoices unless you return finalized: true. Clean up any data, revoke tokens, and remove the installation record from your system.
/v1/installations/{installationId}
const response = await fetch('/v1/installations/installationId', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "finalized": "value"
}
Errors
{
  "error": {
    "code": "forbidden",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    }
  }
}

Authentication

AuthorizationUser Authentication

Default authentication mechanism

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.

cascadeResourceDeletionbooleanOptional
Whether to delete the installation's resources along with the installation
reasonstringOptional
The reason for deleting the installation

Response

200Installation deleted successfully
finalizedobjectOptional
204Installation deleted successfully

Errors

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
Delete Installation | Partner API