PUT /v1/installations/{integrationConfigurationId}/resources/{resourceId}

This endpoint imports (upserts) a resource to Vercel's installation. This may be needed if resources can be independently created on the partner's side and need to be synchronized to Vercel.

Servers

Path parameters

Name Type Required Description
integrationConfigurationId String Yes
resourceId String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
productId String Yes
name String Yes
secrets[] Array No
secrets[].name String Yes
secrets[].prefix String No
secrets[].value String Yes
billingPlan Object No
billingPlan.id String Yes
billingPlan.effectiveDate String No
billingPlan.name String Yes
billingPlan.description String No
billingPlan.paymentMethodRequired Boolean No
billingPlan.type String Yes

Possible values:

  • "prepayment"
  • "subscription"
billingPlan.heightlightedDetails[] Array No
billingPlan.heightlightedDetails[].label String Yes
billingPlan.heightlightedDetails[].value String No
billingPlan.cost String No
billingPlan.details[] Array No
billingPlan.details[].label String Yes
billingPlan.details[].value String No
metadata Object No
status String Yes

Possible values:

  • "suspended"
  • "uninstalled"
  • "error"
  • "ready"
  • "pending"
  • "resumed"
notification Object No
notification.href String No
notification.message String No
notification.level String Yes

Possible values:

  • "warn"
  • "error"
  • "info"
notification.title String Yes

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.