Skip to content
Docs

Update Installation

PATCH/__remote/api.vercel.com/v1/installations/{integrationConfigurationId}
This endpoint updates an integration installation.
/__remote/api.vercel.com/v1/installations/{integrationConfigurationId}
const response = await fetch('/__remote/api.vercel.com/v1/installations/integrationConfigurationId', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "status": "ready",
    "externalId": "example_id",
    "billingPlan": {
      "id": "icfg_1234567890",
      "type": "prepayment",
      "name": "Example Name",
      "description": "string",
      "paymentMethodRequired": "true",
      "cost": "string",
      "details": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "highlightedDetails": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "effectiveDate": "string"
    },
    "notification": {
      "level": "info",
      "title": "string",
      "message": "string",
      "href": "https://example.com"
    }
  }),
});


const data = await response.json();
console.log(data);
Response
{}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationConfigurationIdstringRequired

Request

This endpoint expects an object.

statusstringOptional
externalIdstringOptional
billingPlanobjectOptional
notificationobjectOptional

Response

204Success

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
410Error