ExtensionInstallations

Upgrade or roll back an installation

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.

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

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.

x-api-key<token>

In: header

Path Parameters

id*string
Match^exti_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

version?||null
acceptPermissions?array<>|null
dryRun?boolean|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/extension-installations/string/upgrade" \  -H "Content-Type: application/json" \  -d '{}'
{  "installation": {    "id": "string",    "extensionId": "string",    "name": "string",    "displayName": "string",    "version": {      "id": "string",      "version": "string"    },    "runtime": "hosted",    "status": "active",    "createdAt": "string",    "events": [      "mailbox.message.received"    ],    "permissions": [      "read"    ],    "sendMode": "send",    "scope": {      "mailboxIds": [        "string"      ],      "namespaceId": "string"    },    "webhook": {      "endpointId": "string",      "url": "string"    },    "updatedAt": "string",    "disabledAt": "string"  },  "fromVersion": {    "id": "string",    "version": "string"  },  "toVersion": {    "id": "string",    "version": "string"  },  "permissionDiff": {    "added": [      "permission:read"    ],    "removed": [      "permission:read"    ]  },  "dryRun": true,  "versionChange": {    "id": "string",    "organizationId": "string",    "installationId": "string",    "extensionId": "string",    "fromVersion": {      "id": "string",      "version": "string"    },    "toVersion": {      "id": "string",      "version": "string"    },    "permissionDiff": {      "added": [        "permission:read"      ],      "removed": [        "permission:read"      ]    },    "changedBy": "string",    "changedAt": "string"  }}

Related documentation