Skip to main content
PATCH
Patch Integration

Path Parameters

integration_id
string<uuid>
required

Body

application/json

Body for PATCH /admin/api/v1/integrations/{id}.

The row-level enabled is the single source of truth at assembly; the inner IntegrationConfig.enabled field is ignored and overwritten at assembly time (Phase 4+).

name
string | null
enabled
boolean | null
integration
IntegrationConfig · object | null

Top-level integration configuration.

Each integration binds an external messaging provider to the agent. When the engine starts, it registers webhook endpoints for each enabled integration.

Response

Successful Response

data
StandaloneIntegrationRead · object
required

GET response and the data payload of POST/PATCH/DELETE responses.

reload
StandaloneReloadResult · object
required

Reload outcome attached to every admin mutation response.

reloaded means DB committed and runtime now uses the new config. restart_required means DB committed and process restart is needed. reload_failed means DB rolled back and runtime is unchanged.

Last modified on May 22, 2026