Skip to main content
PATCH
/
v2.0
/
connections
/
{connectionId}
Update a Connection
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "fields": {
    "some-key-from-connection-schema": "x123sdfu12312"
  }
}
'
{
  "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": {}
}

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
ā€‹
fields
object

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

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

Response

Successfully updated Flow