v4

latestOpenAPI 3.0.32026-08-0161180264.4 KB
integrations

updateIntegration

Update an existing integration configuration

put/v1/integrations/{integrationId}

Path parameters

integrationIdstring uuid required

The integration ID

Request body

namestring

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

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