Edit

[POST] .../v1/connectedintegration/edit

Edits a replicated integration connection. Use this method to update a replicated connected integration after it was created by the integration connect workflow. The method can change the active flag, alias, integration settings and schedule; connected_integration_id takes precedence over the deprecated integration_key when both identifiers are provided. For integration settings, value must be present and can be an empty string to clear the stored value. The request body is required and must provide either connected_integration_id or integration_key; schedule is only meaningful for scheduled integrations and null values for optional edit fields leave existing values unchanged unless the field description states otherwise. The current request user must have integration parameters edit access; missing body, missing integration identifier, more than one match by deprecated integration_key, unresolved integration, invalid schedule/settings, integration notification failures and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
alias String Optional Integration alias for DB version 365+. null leaves the DB value unchanged; an empty string is saved as null; length after EscapeStr must not exceed 255 characters.
connected_integration_id String Optional Connected integration ID. Takes precedence over integration_key when both fields are provided.
is_active Boolean Optional Indicates whether the integration is active: true - active, false - inactive.
schedule IntegrationSchedule Optional Integration schedule. Required only when schedule changes are submitted for a scheduled integration.
settings Array of ConnectedIntegrationSettingEdit Optional Integration setting array.

Request Example

{
  "connected_integration_id": "c98210addc4f4e1bb50b17a8c1299a37",
  "is_active": true,
  "alias": "uzum-main",
  "settings": [
    {
      "key": "order_from_id",
      "value": "15",
      "connected_integration_id": "c98210addc4f4e1bb50b17a8c1299a37",
      "firm_id": 1
    }
  ],
  "schedule": {
    "scheduler_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "period_type": "Day",
    "period_value": 1,
    "last_execute": "2026-02-02 09:30:00"
  }
}

Response Parameters

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

Response Example

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