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

This endpoint updates an existing resource in the installation. All parameters are optional, allowing partial updates.

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
extras Object No
name String No
secrets No
billingPlan Object No
billingPlan.id String Yes
billingPlan.effectiveDate String No
billingPlan.name String Yes
billingPlan.description String No
billingPlan.paymentMethodRequired Boolean No
billingPlan.highlightedDetails[] Array No
billingPlan.highlightedDetails[].label String Yes
billingPlan.highlightedDetails[].value String No
billingPlan.type String Yes

Valid values:

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

Valid values:

  • "suspended"
  • "uninstalled"
  • "error"
  • "ready"
  • "onboarding"
  • "pending"
  • "resumed"
notification No
ownership String No

Valid values:

  • "owned"
  • "linked"
  • "sandbox"

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.