Skip to main content
POST
/
v2.0
/
connections
/
{connectionId}
/
fields
Create a Connection Field
curl --request POST \
  --url https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId}/fields \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "key": "some-key-from-connection-schema",
  "value": "x123w123"
}
'
{
  "type": "Bad Request",
  "title": "Bad Request Error",
  "status": 400,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

ā€‹
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

Headers

ā€‹
Accept
enum<string>

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.

Available options:
application/json,
application/hal+json,
application/xml,
text/xml,
text/csv

Path Parameters

ā€‹
connectionId
string
required

The Id of the Connection

Required string length: 24
Pattern: ^[a-z0-9]{24}$

Body

application/json
ā€‹
key
string

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

Example:

"some-key-from-connection-schema"

ā€‹
value
string

The value of the connection field

Example:

"x123w123"

Response

The connection field was created.