Sign in

v4

latestOpenAPI 3.0.32026-08-0161180264.4 KB
integrations

updateIntegrationV2

Update an existing integration with embedded use cases. The integration must already exist. Use cases are updated declaratively:

  • Use cases in the request with matching IDs are updated
  • Use cases in the request without matching IDs are created
  • Existing use cases not in the request are deleted
put/v2/integrations/{integrationId}

Path parameters

integrationIdstring uuid required

The integration ID (client-provided)

Request body

namestring required

Integration name

descriptionstring

Optional description of the integration

access_token_idsstring[]

List of access token IDs associated with this integration

app_idsstring[]

List of app IDs associated with this integration

integration_type'erp' | 'connector'

Type of integration. "erp" is the ERP integration with inbound/outbound use cases. "connector" is for complex proxy integrations with external APIs.

protectedboolean

If true, integration is displayed in read-only mode in the UI to discourage changes

_manifeststring[]

The manifest IDs associated with this integration

Response

Integration updated successfully with use cases

idstring uuid required

Unique identifier for the integration

orgIdstring required

Organization ID

created_atstring date-time required

ISO-8601 timestamp when the integration was created

updated_atstring date-time required

ISO-8601 timestamp when the integration was last updated

namestring required

Integration name

descriptionstring

Optional description of the integration

access_token_idsstring[]

List of access token IDs associated with this integration

app_idsstring[]

List of app IDs associated with this integration

integration_type'erp' | 'connector'

Type of integration. "erp" is the ERP integration with inbound/outbound use cases. "connector" is for complex proxy integrations with external APIs.

protectedboolean

If true, integration is displayed in read-only mode in the UI to discourage changes

_manifeststring[]

The manifest IDs associated with this integration