Edit

[POST] .../v1/integration/edit

Edits local integration. Use this method to update an existing local integration owned by the current account or by another user when the caller has the additional cross-user local-integration permission. The method validates the local integration by key, rejects public integrations, updates the name, endpoint and webhook list in the external REGOS integration registry, then replaces the local webhook subscriptions in the account database and returns a standard OkResult with no payload. The request body is required; key and name are schema-required, key is limited to 150 characters, endpoint is required when webhook subscriptions are provided and endpoint must be an absolute public HTTP or HTTPS URI rather than localhost or a private network address. The current request user must have permission to manage local integrations; if the integration belongs to another user, the persistent layer also requires permission to manage other users' local integrations. Missing body, missing key, missing name, missing endpoint for webhook subscriptions, invalid endpoint, denied access, disabled API-access tariff option, integration not found, multiple matches, attempts to edit a public integration, external registry failures and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
endpoint String Optional Integration endpoint URL. Required when webhook subscriptions are provided. The endpoint must be an absolute non-local HTTP or HTTPS URI.
key String Required Integration key, which is the system name.
name String Required Integration name.
webhooks Array of String Optional Optional webhook event names subscribed by the local integration. If at least one non-empty webhook name is provided, endpoint is required.

Request Example

{
  "key": "2e7d7aeb2a0c449b80dfd8df7f092921",
  "name": "Warehouse bridge",
  "endpoint": "https://bridge.example.test/regos/v2",
  "webhooks": [
    "ItemEdited",
    "DocPurchasePerformed"
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.

Response Example

{
  "ok": true,
  "result": null
}