v1

latestOpenAPI 3.0.0Cognigy Proprietary License2026-07-2239524.1 MB

Connections

Create a Connection Field

Creates a Connection field, allowing you to store additional key-value data in a Connection. This method is useful for adding custom settings required by external services or integrations.

post/v2.0/connections/{connectionId}/fields

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

keystring

The key of the connection field. The key should match the connection schema of the specific connection type.

valuestring

The value of the connection field

Example request

{
  "key": "some-key-from-connection-schema",
  "value": "x123w123"
}

Response

The connection field was created.