Skip to main content

Update an Integration App API by internalId

Updates the latest version of the API. If the latest version is PUBLISHED, a new IN_PROGRESS version is created and changes are applied to it; PUBLISHED rows are never mutated. Acquires a per-entity lock; returns 409 if held.

Path Parameters
internalId string REQUIRED
Request Body REQUIRED
name string

New display name of the API. null = don't change.

description string

New rich-text description. null = don't change.

documentationURL string

New documentation URL. null = don't change.

permittedAuthMechanisms string[]

New auth mechanism IDs. null = don't change. Empty list = explicitly clear the list.

isUserDefinedROB boolean

Whether the output (ROB) of this Action is defined at usage sitenull = don't change.

configurationPatches object[]

RFC-6902 patch operations applied to the active configuration object (integrationAppActionConfiguration / integrationAppTriggerConfiguration / integrationAppPollingConfiguration, depending on integrationAppAPIType). null or empty = no configuration changes.

operationId string
op string
path string
value object
from string
match object
Responses
200

Returns the updated API

Schema OPTIONAL
object