v5

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-02-283466592.5 MB

Integrations (beta)

Update integration configuration

Update an integration configuration. Updating an integration configuration uses a JSON patch representation of the desired changes. To learn more, read Updates.

patch/api/v2/integration-configurations/{integrationConfigurationId}

Path parameters

integrationConfigurationIdstring string required

The ID of the integration configuration

Request body

opstring required

The type of operation to perform

pathstring required

A JSON Pointer string specifying the part of the document to operate on

valuestring

A JSON value used in "add", "replace", and "test" operations

Example request

[
  {
    "op": "replace",
    "path": "/exampleField",
    "value": "new example value"
  }
]

Response

Integration configuration response

_linksobject required

The location and content type of related resources

_idstring required

The unique identifier for this integration configuration

namestring required

A human-friendly name for the integration

_createdAtinteger

_integrationKeystring

The type of integration

tagsstring[]

An array of tags for this integration

enabledboolean

Whether the integration is currently active

configValuesobject

Details on configuration for an integration of this type. Refer to the <code>formVariables</code> field in the corresponding <code>manifest.json</code> for a full list of fields for each integration.