v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Connections

Update a Connection

Updates a Connection in a Project, including type, credential and custom fields.

patch/v2.0/connections/{connectionId}

Path parameters

connectionIdstring required

The Id of the Connection

Headers

Accept'application/json' | 'application/hal+json' | 'application/xml' | 'text/xml' | 'text/csv'

The Accept header specifies the media type that the client expects in the response. Available options: application/json, application/hal+json, application/xml, text/xml, text/csv. The default value is application/json.

Request body

fieldsobject

The fields of the Connection. Key-Value pairs. The key should match the connection schema of the specific connection type.

Example request

{
  "fields": {
    "some-key-from-connection-schema": "x123sdfu12312"
  }
}

Response

Successfully updated Flow