Skip to main content
PATCH
/
v2.0
/
connections
/
{connectionId}
Updates a Connection
curl --request PATCH \
  --url https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "fields": {
    "some-key-from-connection-schema": "x123sdfu12312"
  }
}'
This response does not have an example.

Authorizations

​
X-API-Key
string
header
required

Supply the API Key in the HTTP-Header

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

​
api_key
string
query
required

Supply the API Key in the Url-Query

Headers

​
Accept
enum<string>

The default media type is application/hal+json. Use application/json for pure data results.

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

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

⌘I