Sign in

v2

latestOpenAPI 3.0.4Apache 2.0raw.githubusercontent.com2026-07-1754198241.7 KB
Routes

Update a connector route

Updates a route definition. Implementations should avoid mutating routes that are currently running unless they snapshot the effective route definition into each run.

patch/routes/{routeId}

Path parameters

routeIdstring uuid required

Stable identifier for a connector route.

Example:1e8ff011-2274-4f16-a7dd-bf0b4fd5262f

Stable identifier of a connector route that composes a source operation, destination operation, optional transformation, and trigger policy.

Request body

displayNamestring

Updated route name.

descriptionstring

Updated route description.

sourceBindingIdsOperationBindingId[]

Replacement list of source operation bindings.

destinationBindingIdsOperationBindingId[]

Replacement list of destination operation bindings.

transformationIdstring uuid

Stable identifier for a transformation definition.

atomicity'BEST_EFFORT' | 'PER_RECORD' | 'ALL_OR_NOTHING'

Failure and rollback semantics expected for a route run.

purposestring

Updated processing purpose.

legalBasisstring

Updated legal, contractual, or policy basis.

enabledboolean

Whether this route is eligible for execution.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

Example request

{
  "trigger": {
    "triggerType": "SCHEDULE",
    "schedule": "0 2 * * *"
  },
  "atomicity": "ALL_OR_NOTHING"
}

Response

Connector route updated.

displayNamestring required

Human-readable route name.

descriptionstring

Route purpose and operational boundaries.

sourceBindingIdsOperationBindingId[] required

Source operation bindings that feed this route. More than one source supports enrichment and reference-data joins.

destinationBindingIdsOperationBindingId[] required

Destination operation bindings written by this route. More than one destination supports fan-out.

transformationIdstring uuid

Stable identifier for a transformation definition.

atomicity'BEST_EFFORT' | 'PER_RECORD' | 'ALL_OR_NOTHING'

Failure and rollback semantics expected for a route run.

purposestring

Processing purpose captured at route design time for audit and future governance checks.

legalBasisstring

Legal, contractual, or policy basis for the route's data movement.

enabledboolean

Whether this route is eligible for scheduled, event, webhook, or on-demand execution.

metadataStringMap

Small string-only metadata map for labels, ownership, routing hints, and implementation-specific annotations. Use first-class fields for contractually significant data.

routeIdstring uuid required

Stable identifier for a connector route.

createdAtstring date-time required

Creation timestamp.

updatedAtstring date-time required

Last update timestamp.

createdByUserIdstring

Optional user id that created the route.

updatedByUserIdstring

Optional user id that last updated the route.

deletedAtstring date-time

Soft-delete timestamp. Deleted routes are hidden from normal route lookup and listing but retained for run lineage.

Example response

{
  "routeId": "1e8ff011-2274-4f16-a7dd-bf0b4fd5262f",
  "displayName": "Employee CSV to license invitations",
  "description": "Imports employee rows, maps them to invitation payloads, and writes them to the invitation service.",
  "sourceBindingIds": [
    "2777417e-82ce-4d3e-b96c-94e00a4d9a93"
  ],
  "destinationBindingIds": [
    "b1313b55-ee8c-41d1-8f4f-f4fe2c15e3be"
  ],
  "transformationId": "0e60abcc-41b5-4cc5-bec2-f0047f129341",
  "trigger": {
    "triggerType": "ON_DEMAND"
  },
  "atomicity": "PER_RECORD",
  "purpose": "credential-issuance",
  "legalBasis": "contract",
  "enabled": true,
  "materializationPolicy": {
    "mode": "NONE"
  },
  "createdAt": "2026-06-18T10:00:00Z",
  "updatedAt": "2026-06-18T10:05:00Z"
}