Upsert Installation
PUT
/v1/installations/{installationId}Create or update an installation
/v1/installations/{installationId}
const response = await fetch('/v1/installations/string', { method: 'PUT', headers: { 'Authorization': 'Bearer YOUR_ACCESS_TOKEN', 'Content-Type': 'application/json', }, body: JSON.stringify({ "scopes": [], "acceptedPolicies": "value", "credentials": { "access_token": "string", "token_type": "string" }, "account": { "name": "string", "url": "string", "contact": { "email": "string", "name": "string" } } }),});
const data = await response.json();console.log(data);Response
{ "billingPlan": { "id": "string", "type": "prepayment", "name": "string", "scope": "installation", "description": "string", "paymentMethodRequired": "true", "preauthorizationAmount": "123", "initialCharge": "string", "minimumAmount": "string", "maximumAmount": "string", "maximumAmountAutoPurchasePerPeriod": "string", "cost": "string", "details": [], "highlightedDetails": [], "quote": [], "effectiveDate": "string", "disabled": "true" }, "notification": { "level": "info", "title": "string", "message": "string", "href": "string" }}AuthorizationUser Authentication
Default authentication mechanism
installationIdstringRequired
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
This endpoint expects an object.
scopesarrayRequired
acceptedPoliciesobjectRequired
Policies accepted by the customer. Example: { "toc": "2024-02-28T10:00:00Z" }
credentialsobjectRequired
The service-account access token to access marketplace and integration APIs on behalf of a customer's installation.
accountobjectRequired
The account information for this installation. Use Get Account Info API to re-fetch this data post installation.
The installation was created successfully
billingPlanobjectOptional
The billing plan for the installation. If not set, the installation is billed on resource level.
notificationobjectOptional
Installation's active notification. Example: { "level": "warn", "title": "Account is exceeding the maximum allowed storage no the current plan" }. Return
null to remove any current installation notification.400Input has failed validation
403Operation failed because the authentication is not allowed to perform this operation
409Operation failed because of a conflict with the current state of the resource