---
title: "Upgrade or roll back an installation"
method: POST
path: "/v1/extension-installations/{id}/upgrade"
tags: ["Extension installations"]
---

# Upgrade or roll back an installation

`POST /v1/extension-installations/{id}/upgrade`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/extension-installations/{id}/upgrade`
- Auth: API key in header `x-api-key`

Changes the pinned version in place. Omit version for the latest publication, or name a version string or id, including an older version to roll back. Preview with dryRun; changing requires acceptPermissions to list exactly the added permission: and event: grants. Only a person can upgrade. Credentials, owner, scope, send mode, and status stay attached to the installation.

## Path parameters

- `id` string, required

## Request body

- UpgradeExtensionPayload
  - `version` union
    - string
    - string
  - `acceptPermissions` string[], nullable
  - `dryRun` boolean, nullable

## Response `200`

UpgradeExtensionResponse

- UpgradeExtensionResponse
  - `installation` ExtensionInstallation, required
    - `id` string, required
    - `extensionId` string, required
    - `name` string, required
    - `displayName` string, required
    - `version` ExtensionVersionRef, required
      - `id` string, required
      - `version` string, required
    - `runtime` 'hosted' | 'webhook', required
    - `status` 'active' | 'disabled', required
    - `createdAt` string, required
    - `events` string[], required
    - `permissions` string[], required
    - `sendMode` 'send' | 'approval', required
    - `scope` object, required
      - `mailboxIds` MailboxId[], nullable, required
      - `namespaceId` string, required
    - `webhook` object, nullable, required
      - `endpointId` string, required
      - `url` string, required
    - `updatedAt` string, required
    - `disabledAt` string, nullable, required
  - `fromVersion` ExtensionVersionRef, required
    - `id` string, required
    - `version` string, required
  - `toVersion` ExtensionVersionRef, required
    - `id` string, required
    - `version` string, required
  - `permissionDiff` ExtensionPermissionDiff, required
    - `added` string[], required
    - `removed` string[], required
  - `dryRun` boolean, required
  - `versionChange` ExtensionVersionChange, required
    - `id` string, required
    - `organizationId` string, required
    - `installationId` string, required
    - `extensionId` string, required
    - `fromVersion` ExtensionVersionRef, required
      - `id` string, required
      - `version` string, required
    - `toVersion` ExtensionVersionRef, required
      - `id` string, required
      - `version` string, required
    - `permissionDiff` ExtensionPermissionDiff, required
      - `added` string[], required
      - `removed` string[], required
    - `changedBy` string, required
    - `changedAt` string, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `404`: ResourceNotFoundError
- `409`: ConflictError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

[API](https://skmtc.dev/samva/apis/samva-api.md) · [All operations](https://skmtc.dev/samva/apis/samva-api/llms.txt) · [OpenAPI document](https://skmtc.dev/samva/apis/samva-api/revisions/a99408542cc3?raw)