Update a Connection - Cognigy Documentation

Documentation Index

Fetch the complete documentation index at: /llms.txt

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

Update a Connection

PATCH

/v2.0/connections/{connectionId}

Try it

cURL

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"
  }
}
'```

#### Python

```python
import requests

url = "https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId}"

payload = { "fields": { "some-key-from-connection-schema": "x123sdfu12312" } }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({fields: {'some-key-from-connection-schema': 'x123sdfu12312'}})
};

fetch('https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

$curl = curl_init();

curl_setopt_array($curl, [\
  CURLOPT_URL => "https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId}",\
  CURLOPT_RETURNTRANSFER => true,\
  CURLOPT_ENCODING => "",\
  CURLOPT_MAXREDIRS => 10,\
  CURLOPT_TIMEOUT => 30,\
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
  CURLOPT_CUSTOMREQUEST => "PATCH",\
  CURLOPT_POSTFIELDS => json_encode([\
    'fields' => [\
        'some-key-from-connection-schema' => 'x123sdfu12312'\
    ]\
  ]),\
  CURLOPT_HTTPHEADER => [\
    "Content-Type: application/json",\
    "X-API-Key: <api-key>"\
  ],\
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go

package main

import (
    "fmt"
    "strings"
    "net/http"
    "io"
)

func main() {

url := "https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId}"

payload := strings.NewReader("{\n  \"fields\": {\n    \"some-key-from-connection-schema\": \"x123sdfu12312\"\n  }\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
    req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Java (Unirest)

HttpResponse<String> response = Unirest.patch("https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fields\": {\n    \"some-key-from-connection-schema\": \"x123sdfu12312\"\n  }\n}")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api-trial.cognigy.ai/new/v2.0/connections/{connectionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"fields\": {\n    \"some-key-from-connection-schema\": \"x123sdfu12312\"\n  }\n}"

response = http.request(request)
puts response.read_body

Response Codes

• 204: Successfully updated Flow
• Errors: The following are possible HTTP error responses:

{
  "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": {}
}

{
  "type": "Unauthorized",
  "title": "Unauthorized Error",
  "status": 401,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 401,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Payment Required",
  "title": "Payment Required Error",
  "status": 402,
  "detail": "Validation failed. Missing payload.",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 402,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Forbidden",
  "title": "Forbidden Error",
  "status": 403,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {}
}

{
  "type": "Not Found",
  "title": "Not Found Error",
  "status": 404,
  "detail": "<string>",
  "instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
  "code": 1000,
  "traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
  "details": {},
  "logLevel": "error"
}

Authorizations

• X-API-Key (header): Supply the API Key in the HTTP header.

Headers

• Accept (enum): 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.

Path Parameters

• connectionId (string): The Id of the Connection. Required string length: 24, Pattern: ^[a-z0-9]{24}$.

Body

• 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"
}