Update an Endpoint
Updates Endpoint settings in a Project. Allows modifying the Endpoint’s activation status, Transformers, handover, analytics, and privacy options.
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": true,
"nluConnectorId": "cognigy",
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true,
"useContactProfiles": true,
"useAnalytics": true,
"useDashbotAnalytics": true,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": true,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": true,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": true,
"disableInputAutocomplete": true,
"disableInputAutogrow": true,
"disableUrlButtonSanitization": true,
"enableGenericHTMLStyling": true,
"enableAsyncCommunication": true,
"engagementMessageText": "<string>",
"displayGetStartedButton": true,
"dynamicImageAspectRatio": true,
"enableCollectMetadata": true,
"enableConnectionStatusIndicator": true,
"enableDemoWebchat": true,
"enableFileUpload": true,
"enablePersistentMenu": true,
"enableSTT": true,
"enableTTS": true,
"enableUnreadMessageBadge": true,
"enableUnreadMessagePreview": true,
"enableUnreadMessageSound": true,
"enableUnreadMessageTitleIndicator": true,
"enableTypingIndicator": true,
"facebookPageToken": "<string>",
"focusInputAfterPostback": true,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": true,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": true,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": true,
"requestFacebookProfileData": true,
"restEndpointAuthentication": {},
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": true,
"showEngagementMessagesInChat": true,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": true,
"voice": "<string>",
"webhookEndpointAuthentication": {},
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": true,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": true,
"outputTransformerEnabled": true,
"finalPingTransformerEnabled": true,
"notifyTransformerEnabled": true,
"injectTransformerEnabled": true
},
"handoverSettings": {
"providerSettings": {
"forwardOnlyHandoverConversations": true,
"getQueueUpdates": true,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": true,
"enableTranscriptTileChatInput": true,
"redactTranscriptTileMessages": true,
"enableAgentCopilotAuthentication": true,
"blockNonJWTRequests": true,
"agentCopilotAuthentication": "<string>",
"copilotAuthenticationPublicKeys": [
"<string>"
],
"copilotAuthenticationKeyStoreUrl": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": true,
"useAnalytics": true,
"storeDataPayload": true,
"useContactProfiles": true,
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true
}
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}"
payload = {
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": True,
"nluConnectorId": "cognigy",
"useConversations": True,
"maskIPAddress": True,
"maskAnalytics": True,
"maskLogging": True,
"useContactProfiles": True,
"useAnalytics": True,
"useDashbotAnalytics": True,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": True,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": True,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": True,
"disableInputAutocomplete": True,
"disableInputAutogrow": True,
"disableUrlButtonSanitization": True,
"enableGenericHTMLStyling": True,
"enableAsyncCommunication": True,
"engagementMessageText": "<string>",
"displayGetStartedButton": True,
"dynamicImageAspectRatio": True,
"enableCollectMetadata": True,
"enableConnectionStatusIndicator": True,
"enableDemoWebchat": True,
"enableFileUpload": True,
"enablePersistentMenu": True,
"enableSTT": True,
"enableTTS": True,
"enableUnreadMessageBadge": True,
"enableUnreadMessagePreview": True,
"enableUnreadMessageSound": True,
"enableUnreadMessageTitleIndicator": True,
"enableTypingIndicator": True,
"facebookPageToken": "<string>",
"focusInputAfterPostback": True,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": True,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": True,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": True,
"requestFacebookProfileData": True,
"restEndpointAuthentication": {},
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": True,
"showEngagementMessagesInChat": True,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": True,
"voice": "<string>",
"webhookEndpointAuthentication": {},
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": True,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": True,
"outputTransformerEnabled": True,
"finalPingTransformerEnabled": True,
"notifyTransformerEnabled": True,
"injectTransformerEnabled": True
},
"handoverSettings": {
"providerSettings": {
"forwardOnlyHandoverConversations": True,
"getQueueUpdates": True,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": True,
"enableTranscriptTileChatInput": True,
"redactTranscriptTileMessages": True,
"enableAgentCopilotAuthentication": True,
"blockNonJWTRequests": True,
"agentCopilotAuthentication": "<string>",
"copilotAuthenticationPublicKeys": ["<string>"],
"copilotAuthenticationKeyStoreUrl": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": True,
"useAnalytics": True,
"storeDataPayload": True,
"useContactProfiles": True,
"useConversations": True,
"maskIPAddress": True,
"maskAnalytics": True,
"maskLogging": True
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
foreignId: '<string>',
channel: 'webchat3',
flowId: '<string>',
localeId: '<string>',
URLToken: 'f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f',
name: 'New Endpoint',
entrypoint: '667ed4ae16d66f47dc2a9400',
active: true,
nluConnectorId: 'cognigy',
useConversations: true,
maskIPAddress: true,
maskAnalytics: true,
maskLogging: true,
useContactProfiles: true,
useAnalytics: true,
useDashbotAnalytics: true,
dashbotApikey: '<string>',
dashbotPlatform: '<string>',
disableInputSanitization: '<string>',
disableSkipUriTags: '<string>',
overrideSnapshotConnections: true,
settings: {
accessScope: '<string>',
accessToken: '<string>',
appId: '<string>',
appSecret: '<string>',
backgroundImageUrl: '<string>',
basicAuthPassword: '<string>',
basicAuthUser: '<string>',
botUserId: '<string>',
businessHours: {
businessHours: [{startTime: '<string>', endTime: '<string>', weekDay: '<string>'}],
enabled: true,
text: '<string>',
mode: '<string>',
timeZone: '<string>',
title: '<string>'
},
colorScheme: '<string>',
connectionName: '<string>',
customJSON: '<string>',
designTemplate: 123,
disableHtmlContentSanitization: true,
disableInputAutocomplete: true,
disableInputAutogrow: true,
disableUrlButtonSanitization: true,
enableGenericHTMLStyling: true,
enableAsyncCommunication: true,
engagementMessageText: '<string>',
displayGetStartedButton: true,
dynamicImageAspectRatio: true,
enableCollectMetadata: true,
enableConnectionStatusIndicator: true,
enableDemoWebchat: true,
enableFileUpload: true,
enablePersistentMenu: true,
enableSTT: true,
enableTTS: true,
enableUnreadMessageBadge: true,
enableUnreadMessagePreview: true,
enableUnreadMessageSound: true,
enableUnreadMessageTitleIndicator: true,
enableTypingIndicator: true,
facebookPageToken: '<string>',
focusInputAfterPostback: true,
getStartedButtonText: '<string>',
getStartedPayload: '<string>',
getStartedText: '<string>',
getStartedData: '<string>',
headerLogoUrl: '<string>',
hubSecret: '<string>',
inputAutogrowMaxRows: 123,
inputPlaceholder: '<string>',
language: '<string>',
lineChannelAccessToken: '<string>',
lineChannelSecret: '<string>',
maintenance: {enabled: true, mode: '<string>', text: '<string>', title: '<string>'},
mergeContactProfiles: true,
messageDelay: 123,
messageLogoUrl: '<string>',
overwriteWebchatBundleUrl: '<string>',
ratingTitleText: '<string>',
ratingCommentText: '<string>',
ratingMessageHistoryRatingText: '<string>',
ratingMessageHistoryCommentText: '<string>',
reparseAlexaSlots: true,
requestFacebookProfileData: true,
restEndpointAuthentication: {},
sessionExpiration: 123,
shouldOverwriteWebchatBundleUrl: true,
showEngagementMessagesInChat: true,
slackOAuthAccessToken: '<string>',
slackVerifyToken: '<string>',
sunshineConversationsChannelKeyId: '<string>',
sunshineConversationsChannelSecret: '<string>',
sunshineConversationsChannelUri: '<string>',
tenantId: '<string>',
updateContactProfileWithFacebookProfile: true,
voice: '<string>',
webhookEndpointAuthentication: {},
webhookUrl: '<string>',
skill: {},
persistentMenu: {}
},
transformer: {
abortOnError: true,
transformer: '<string>',
transpiledTransformer: '<string>',
inputTransformerEnabled: true,
outputTransformerEnabled: true,
finalPingTransformerEnabled: true,
notifyTransformerEnabled: true,
injectTransformerEnabled: true
},
handoverSettings: {
providerSettings: {
forwardOnlyHandoverConversations: true,
getQueueUpdates: true,
apiVersion: '<string>',
baseUrl: '<string>',
apiAccessToken: '<string>',
baseApiUrl: '<string>',
realtimeAccessToken: '<string>',
realtimeEndpointUrl: '<string>',
webhookSecret: '<string>',
botCategoryId: '<string>',
agentCategoryId: '<string>',
organizationId: '<string>',
deploymentId: '<string>',
buttonId: '<string>'
},
agentAssistSettings: {
agentAssistFlowId: '<string>',
agentAssistConfigId: '<string>',
enableTranscriptTile: true,
enableTranscriptTileChatInput: true,
redactTranscriptTileMessages: true,
enableAgentCopilotAuthentication: true,
blockNonJWTRequests: true,
agentCopilotAuthentication: '<string>',
copilotAuthenticationPublicKeys: ['<string>'],
copilotAuthenticationKeyStoreUrl: '<string>',
oAuth2Connection: '<string>'
}
},
orgDataPrivacySettings: {
enabled: true,
useAnalytics: true,
storeDataPayload: true,
useContactProfiles: true,
useConversations: true,
maskIPAddress: true,
maskAnalytics: true,
maskLogging: true
}
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}', 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/endpoints/{endpointId}",
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([
'foreignId' => '<string>',
'channel' => 'webchat3',
'flowId' => '<string>',
'localeId' => '<string>',
'URLToken' => 'f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f',
'name' => 'New Endpoint',
'entrypoint' => '667ed4ae16d66f47dc2a9400',
'active' => true,
'nluConnectorId' => 'cognigy',
'useConversations' => true,
'maskIPAddress' => true,
'maskAnalytics' => true,
'maskLogging' => true,
'useContactProfiles' => true,
'useAnalytics' => true,
'useDashbotAnalytics' => true,
'dashbotApikey' => '<string>',
'dashbotPlatform' => '<string>',
'disableInputSanitization' => '<string>',
'disableSkipUriTags' => '<string>',
'overrideSnapshotConnections' => true,
'settings' => [
'accessScope' => '<string>',
'accessToken' => '<string>',
'appId' => '<string>',
'appSecret' => '<string>',
'backgroundImageUrl' => '<string>',
'basicAuthPassword' => '<string>',
'basicAuthUser' => '<string>',
'botUserId' => '<string>',
'businessHours' => [
'businessHours' => [
[
'startTime' => '<string>',
'endTime' => '<string>',
'weekDay' => '<string>'
]
],
'enabled' => true,
'text' => '<string>',
'mode' => '<string>',
'timeZone' => '<string>',
'title' => '<string>'
],
'colorScheme' => '<string>',
'connectionName' => '<string>',
'customJSON' => '<string>',
'designTemplate' => 123,
'disableHtmlContentSanitization' => true,
'disableInputAutocomplete' => true,
'disableInputAutogrow' => true,
'disableUrlButtonSanitization' => true,
'enableGenericHTMLStyling' => true,
'enableAsyncCommunication' => true,
'engagementMessageText' => '<string>',
'displayGetStartedButton' => true,
'dynamicImageAspectRatio' => true,
'enableCollectMetadata' => true,
'enableConnectionStatusIndicator' => true,
'enableDemoWebchat' => true,
'enableFileUpload' => true,
'enablePersistentMenu' => true,
'enableSTT' => true,
'enableTTS' => true,
'enableUnreadMessageBadge' => true,
'enableUnreadMessagePreview' => true,
'enableUnreadMessageSound' => true,
'enableUnreadMessageTitleIndicator' => true,
'enableTypingIndicator' => true,
'facebookPageToken' => '<string>',
'focusInputAfterPostback' => true,
'getStartedButtonText' => '<string>',
'getStartedPayload' => '<string>',
'getStartedText' => '<string>',
'getStartedData' => '<string>',
'headerLogoUrl' => '<string>',
'hubSecret' => '<string>',
'inputAutogrowMaxRows' => 123,
'inputPlaceholder' => '<string>',
'language' => '<string>',
'lineChannelAccessToken' => '<string>',
'lineChannelSecret' => '<string>',
'maintenance' => [
'enabled' => true,
'mode' => '<string>',
'text' => '<string>',
'title' => '<string>'
],
'mergeContactProfiles' => true,
'messageDelay' => 123,
'messageLogoUrl' => '<string>',
'overwriteWebchatBundleUrl' => '<string>',
'ratingTitleText' => '<string>',
'ratingCommentText' => '<string>',
'ratingMessageHistoryRatingText' => '<string>',
'ratingMessageHistoryCommentText' => '<string>',
'reparseAlexaSlots' => true,
'requestFacebookProfileData' => true,
'restEndpointAuthentication' => [
],
'sessionExpiration' => 123,
'shouldOverwriteWebchatBundleUrl' => true,
'showEngagementMessagesInChat' => true,
'slackOAuthAccessToken' => '<string>',
'slackVerifyToken' => '<string>',
'sunshineConversationsChannelKeyId' => '<string>',
'sunshineConversationsChannelSecret' => '<string>',
'sunshineConversationsChannelUri' => '<string>',
'tenantId' => '<string>',
'updateContactProfileWithFacebookProfile' => true,
'voice' => '<string>',
'webhookEndpointAuthentication' => [
],
'webhookUrl' => '<string>',
'skill' => [
],
'persistentMenu' => [
]
],
'transformer' => [
'abortOnError' => true,
'transformer' => '<string>',
'transpiledTransformer' => '<string>',
'inputTransformerEnabled' => true,
'outputTransformerEnabled' => true,
'finalPingTransformerEnabled' => true,
'notifyTransformerEnabled' => true,
'injectTransformerEnabled' => true
],
'handoverSettings' => [
'providerSettings' => [
'forwardOnlyHandoverConversations' => true,
'getQueueUpdates' => true,
'apiVersion' => '<string>',
'baseUrl' => '<string>',
'apiAccessToken' => '<string>',
'baseApiUrl' => '<string>',
'realtimeAccessToken' => '<string>',
'realtimeEndpointUrl' => '<string>',
'webhookSecret' => '<string>',
'botCategoryId' => '<string>',
'agentCategoryId' => '<string>',
'organizationId' => '<string>',
'deploymentId' => '<string>',
'buttonId' => '<string>'
],
'agentAssistSettings' => [
'agentAssistFlowId' => '<string>',
'agentAssistConfigId' => '<string>',
'enableTranscriptTile' => true,
'enableTranscriptTileChatInput' => true,
'redactTranscriptTileMessages' => true,
'enableAgentCopilotAuthentication' => true,
'blockNonJWTRequests' => true,
'agentCopilotAuthentication' => '<string>',
'copilotAuthenticationPublicKeys' => [
'<string>'
],
'copilotAuthenticationKeyStoreUrl' => '<string>',
'oAuth2Connection' => '<string>'
]
],
'orgDataPrivacySettings' => [
'enabled' => true,
'useAnalytics' => true,
'storeDataPayload' => true,
'useContactProfiles' => true,
'useConversations' => true,
'maskIPAddress' => true,
'maskAnalytics' => true,
'maskLogging' => true
]
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}"
payload := strings.NewReader("{\n \"foreignId\": \"<string>\",\n \"channel\": \"webchat3\",\n \"flowId\": \"<string>\",\n \"localeId\": \"<string>\",\n \"URLToken\": \"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f\",\n \"name\": \"New Endpoint\",\n \"entrypoint\": \"667ed4ae16d66f47dc2a9400\",\n \"active\": true,\n \"nluConnectorId\": \"cognigy\",\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true,\n \"useContactProfiles\": true,\n \"useAnalytics\": true,\n \"useDashbotAnalytics\": true,\n \"dashbotApikey\": \"<string>\",\n \"dashbotPlatform\": \"<string>\",\n \"disableInputSanitization\": \"<string>\",\n \"disableSkipUriTags\": \"<string>\",\n \"overrideSnapshotConnections\": true,\n \"settings\": {\n \"accessScope\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"appId\": \"<string>\",\n \"appSecret\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"basicAuthPassword\": \"<string>\",\n \"basicAuthUser\": \"<string>\",\n \"botUserId\": \"<string>\",\n \"businessHours\": {\n \"businessHours\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"weekDay\": \"<string>\"\n }\n ],\n \"enabled\": true,\n \"text\": \"<string>\",\n \"mode\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"colorScheme\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"customJSON\": \"<string>\",\n \"designTemplate\": 123,\n \"disableHtmlContentSanitization\": true,\n \"disableInputAutocomplete\": true,\n \"disableInputAutogrow\": true,\n \"disableUrlButtonSanitization\": true,\n \"enableGenericHTMLStyling\": true,\n \"enableAsyncCommunication\": true,\n \"engagementMessageText\": \"<string>\",\n \"displayGetStartedButton\": true,\n \"dynamicImageAspectRatio\": true,\n \"enableCollectMetadata\": true,\n \"enableConnectionStatusIndicator\": true,\n \"enableDemoWebchat\": true,\n \"enableFileUpload\": true,\n \"enablePersistentMenu\": true,\n \"enableSTT\": true,\n \"enableTTS\": true,\n \"enableUnreadMessageBadge\": true,\n \"enableUnreadMessagePreview\": true,\n \"enableUnreadMessageSound\": true,\n \"enableUnreadMessageTitleIndicator\": true,\n \"enableTypingIndicator\": true,\n \"facebookPageToken\": \"<string>\",\n \"focusInputAfterPostback\": true,\n \"getStartedButtonText\": \"<string>\",\n \"getStartedPayload\": \"<string>\",\n \"getStartedText\": \"<string>\",\n \"getStartedData\": \"<string>\",\n \"headerLogoUrl\": \"<string>\",\n \"hubSecret\": \"<string>\",\n \"inputAutogrowMaxRows\": 123,\n \"inputPlaceholder\": \"<string>\",\n \"language\": \"<string>\",\n \"lineChannelAccessToken\": \"<string>\",\n \"lineChannelSecret\": \"<string>\",\n \"maintenance\": {\n \"enabled\": true,\n \"mode\": \"<string>\",\n \"text\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"mergeContactProfiles\": true,\n \"messageDelay\": 123,\n \"messageLogoUrl\": \"<string>\",\n \"overwriteWebchatBundleUrl\": \"<string>\",\n \"ratingTitleText\": \"<string>\",\n \"ratingCommentText\": \"<string>\",\n \"ratingMessageHistoryRatingText\": \"<string>\",\n \"ratingMessageHistoryCommentText\": \"<string>\",\n \"reparseAlexaSlots\": true,\n \"requestFacebookProfileData\": true,\n \"restEndpointAuthentication\": {},\n \"sessionExpiration\": 123,\n \"shouldOverwriteWebchatBundleUrl\": true,\n \"showEngagementMessagesInChat\": true,\n \"slackOAuthAccessToken\": \"<string>\",\n \"slackVerifyToken\": \"<string>\",\n \"sunshineConversationsChannelKeyId\": \"<string>\",\n \"sunshineConversationsChannelSecret\": \"<string>\",\n \"sunshineConversationsChannelUri\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updateContactProfileWithFacebookProfile\": true,\n \"voice\": \"<string>\",\n \"webhookEndpointAuthentication\": {},\n \"webhookUrl\": \"<string>\",\n \"skill\": {},\n \"persistentMenu\": {}\n },\n \"transformer\": {\n \"abortOnError\": true,\n \"transformer\": \"<string>\",\n \"transpiledTransformer\": \"<string>\",\n \"inputTransformerEnabled\": true,\n \"outputTransformerEnabled\": true,\n \"finalPingTransformerEnabled\": true,\n \"notifyTransformerEnabled\": true,\n \"injectTransformerEnabled\": true\n },\n \"handoverSettings\": {\n \"providerSettings\": {\n \"forwardOnlyHandoverConversations\": true,\n \"getQueueUpdates\": true,\n \"apiVersion\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"apiAccessToken\": \"<string>\",\n \"baseApiUrl\": \"<string>\",\n \"realtimeAccessToken\": \"<string>\",\n \"realtimeEndpointUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"botCategoryId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"deploymentId\": \"<string>\",\n \"buttonId\": \"<string>\"\n },\n \"agentAssistSettings\": {\n \"agentAssistFlowId\": \"<string>\",\n \"agentAssistConfigId\": \"<string>\",\n \"enableTranscriptTile\": true,\n \"enableTranscriptTileChatInput\": true,\n \"redactTranscriptTileMessages\": true,\n \"enableAgentCopilotAuthentication\": true,\n \"blockNonJWTRequests\": true,\n \"agentCopilotAuthentication\": \"<string>\",\n \"copilotAuthenticationPublicKeys\": [\n \"<string>\"\n ],\n \"copilotAuthenticationKeyStoreUrl\": \"<string>\",\n \"oAuth2Connection\": \"<string>\"\n }\n },\n \"orgDataPrivacySettings\": {\n \"enabled\": true,\n \"useAnalytics\": true,\n \"storeDataPayload\": true,\n \"useContactProfiles\": true,\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true\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))
}HttpResponse<String> response = Unirest.patch("https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"foreignId\": \"<string>\",\n \"channel\": \"webchat3\",\n \"flowId\": \"<string>\",\n \"localeId\": \"<string>\",\n \"URLToken\": \"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f\",\n \"name\": \"New Endpoint\",\n \"entrypoint\": \"667ed4ae16d66f47dc2a9400\",\n \"active\": true,\n \"nluConnectorId\": \"cognigy\",\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true,\n \"useContactProfiles\": true,\n \"useAnalytics\": true,\n \"useDashbotAnalytics\": true,\n \"dashbotApikey\": \"<string>\",\n \"dashbotPlatform\": \"<string>\",\n \"disableInputSanitization\": \"<string>\",\n \"disableSkipUriTags\": \"<string>\",\n \"overrideSnapshotConnections\": true,\n \"settings\": {\n \"accessScope\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"appId\": \"<string>\",\n \"appSecret\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"basicAuthPassword\": \"<string>\",\n \"basicAuthUser\": \"<string>\",\n \"botUserId\": \"<string>\",\n \"businessHours\": {\n \"businessHours\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"weekDay\": \"<string>\"\n }\n ],\n \"enabled\": true,\n \"text\": \"<string>\",\n \"mode\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"colorScheme\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"customJSON\": \"<string>\",\n \"designTemplate\": 123,\n \"disableHtmlContentSanitization\": true,\n \"disableInputAutocomplete\": true,\n \"disableInputAutogrow\": true,\n \"disableUrlButtonSanitization\": true,\n \"enableGenericHTMLStyling\": true,\n \"enableAsyncCommunication\": true,\n \"engagementMessageText\": \"<string>\",\n \"displayGetStartedButton\": true,\n \"dynamicImageAspectRatio\": true,\n \"enableCollectMetadata\": true,\n \"enableConnectionStatusIndicator\": true,\n \"enableDemoWebchat\": true,\n \"enableFileUpload\": true,\n \"enablePersistentMenu\": true,\n \"enableSTT\": true,\n \"enableTTS\": true,\n \"enableUnreadMessageBadge\": true,\n \"enableUnreadMessagePreview\": true,\n \"enableUnreadMessageSound\": true,\n \"enableUnreadMessageTitleIndicator\": true,\n \"enableTypingIndicator\": true,\n \"facebookPageToken\": \"<string>\",\n \"focusInputAfterPostback\": true,\n \"getStartedButtonText\": \"<string>\",\n \"getStartedPayload\": \"<string>\",\n \"getStartedText\": \"<string>\",\n \"getStartedData\": \"<string>\",\n \"headerLogoUrl\": \"<string>\",\n \"hubSecret\": \"<string>\",\n \"inputAutogrowMaxRows\": 123,\n \"inputPlaceholder\": \"<string>\",\n \"language\": \"<string>\",\n \"lineChannelAccessToken\": \"<string>\",\n \"lineChannelSecret\": \"<string>\",\n \"maintenance\": {\n \"enabled\": true,\n \"mode\": \"<string>\",\n \"text\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"mergeContactProfiles\": true,\n \"messageDelay\": 123,\n \"messageLogoUrl\": \"<string>\",\n \"overwriteWebchatBundleUrl\": \"<string>\",\n \"ratingTitleText\": \"<string>\",\n \"ratingCommentText\": \"<string>\",\n \"ratingMessageHistoryRatingText\": \"<string>\",\n \"ratingMessageHistoryCommentText\": \"<string>\",\n \"reparseAlexaSlots\": true,\n \"requestFacebookProfileData\": true,\n \"restEndpointAuthentication\": {},\n \"sessionExpiration\": 123,\n \"shouldOverwriteWebchatBundleUrl\": true,\n \"showEngagementMessagesInChat\": true,\n \"slackOAuthAccessToken\": \"<string>\",\n \"slackVerifyToken\": \"<string>\",\n \"sunshineConversationsChannelKeyId\": \"<string>\",\n \"sunshineConversationsChannelSecret\": \"<string>\",\n \"sunshineConversationsChannelUri\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updateContactProfileWithFacebookProfile\": true,\n \"voice\": \"<string>\",\n \"webhookEndpointAuthentication\": {},\n \"webhookUrl\": \"<string>\",\n \"skill\": {},\n \"persistentMenu\": {}\n },\n \"transformer\": {\n \"abortOnError\": true,\n \"transformer\": \"<string>\",\n \"transpiledTransformer\": \"<string>\",\n \"inputTransformerEnabled\": true,\n \"outputTransformerEnabled\": true,\n \"finalPingTransformerEnabled\": true,\n \"notifyTransformerEnabled\": true,\n \"injectTransformerEnabled\": true\n },\n \"handoverSettings\": {\n \"providerSettings\": {\n \"forwardOnlyHandoverConversations\": true,\n \"getQueueUpdates\": true,\n \"apiVersion\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"apiAccessToken\": \"<string>\",\n \"baseApiUrl\": \"<string>\",\n \"realtimeAccessToken\": \"<string>\",\n \"realtimeEndpointUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"botCategoryId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"deploymentId\": \"<string>\",\n \"buttonId\": \"<string>\"\n },\n \"agentAssistSettings\": {\n \"agentAssistFlowId\": \"<string>\",\n \"agentAssistConfigId\": \"<string>\",\n \"enableTranscriptTile\": true,\n \"enableTranscriptTileChatInput\": true,\n \"redactTranscriptTileMessages\": true,\n \"enableAgentCopilotAuthentication\": true,\n \"blockNonJWTRequests\": true,\n \"agentCopilotAuthentication\": \"<string>\",\n \"copilotAuthenticationPublicKeys\": [\n \"<string>\"\n ],\n \"copilotAuthenticationKeyStoreUrl\": \"<string>\",\n \"oAuth2Connection\": \"<string>\"\n }\n },\n \"orgDataPrivacySettings\": {\n \"enabled\": true,\n \"useAnalytics\": true,\n \"storeDataPayload\": true,\n \"useContactProfiles\": true,\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}")
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 \"foreignId\": \"<string>\",\n \"channel\": \"webchat3\",\n \"flowId\": \"<string>\",\n \"localeId\": \"<string>\",\n \"URLToken\": \"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f\",\n \"name\": \"New Endpoint\",\n \"entrypoint\": \"667ed4ae16d66f47dc2a9400\",\n \"active\": true,\n \"nluConnectorId\": \"cognigy\",\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true,\n \"useContactProfiles\": true,\n \"useAnalytics\": true,\n \"useDashbotAnalytics\": true,\n \"dashbotApikey\": \"<string>\",\n \"dashbotPlatform\": \"<string>\",\n \"disableInputSanitization\": \"<string>\",\n \"disableSkipUriTags\": \"<string>\",\n \"overrideSnapshotConnections\": true,\n \"settings\": {\n \"accessScope\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"appId\": \"<string>\",\n \"appSecret\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"basicAuthPassword\": \"<string>\",\n \"basicAuthUser\": \"<string>\",\n \"botUserId\": \"<string>\",\n \"businessHours\": {\n \"businessHours\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"weekDay\": \"<string>\"\n }\n ],\n \"enabled\": true,\n \"text\": \"<string>\",\n \"mode\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"colorScheme\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"customJSON\": \"<string>\",\n \"designTemplate\": 123,\n \"disableHtmlContentSanitization\": true,\n \"disableInputAutocomplete\": true,\n \"disableInputAutogrow\": true,\n \"disableUrlButtonSanitization\": true,\n \"enableGenericHTMLStyling\": true,\n \"enableAsyncCommunication\": true,\n \"engagementMessageText\": \"<string>\",\n \"displayGetStartedButton\": true,\n \"dynamicImageAspectRatio\": true,\n \"enableCollectMetadata\": true,\n \"enableConnectionStatusIndicator\": true,\n \"enableDemoWebchat\": true,\n \"enableFileUpload\": true,\n \"enablePersistentMenu\": true,\n \"enableSTT\": true,\n \"enableTTS\": true,\n \"enableUnreadMessageBadge\": true,\n \"enableUnreadMessagePreview\": true,\n \"enableUnreadMessageSound\": true,\n \"enableUnreadMessageTitleIndicator\": true,\n \"enableTypingIndicator\": true,\n \"facebookPageToken\": \"<string>\",\n \"focusInputAfterPostback\": true,\n \"getStartedButtonText\": \"<string>\",\n \"getStartedPayload\": \"<string>\",\n \"getStartedText\": \"<string>\",\n \"getStartedData\": \"<string>\",\n \"headerLogoUrl\": \"<string>\",\n \"hubSecret\": \"<string>\",\n \"inputAutogrowMaxRows\": 123,\n \"inputPlaceholder\": \"<string>\",\n \"language\": \"<string>\",\n \"lineChannelAccessToken\": \"<string>\",\n \"lineChannelSecret\": \"<string>\",\n \"maintenance\": {\n \"enabled\": true,\n \"mode\": \"<string>\",\n \"text\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"mergeContactProfiles\": true,\n \"messageDelay\": 123,\n \"messageLogoUrl\": \"<string>\",\n \"overwriteWebchatBundleUrl\": \"<string>\",\n \"ratingTitleText\": \"<string>\",\n \"ratingCommentText\": \"<string>\",\n \"ratingMessageHistoryRatingText\": \"<string>\",\n \"ratingMessageHistoryCommentText\": \"<string>\",\n \"reparseAlexaSlots\": true,\n \"requestFacebookProfileData\": true,\n \"restEndpointAuthentication\": {},\n \"sessionExpiration\": 123,\n \"shouldOverwriteWebchatBundleUrl\": true,\n \"showEngagementMessagesInChat\": true,\n \"slackOAuthAccessToken\": \"<string>\",\n \"slackVerifyToken\": \"<string>\",\n \"sunshineConversationsChannelKeyId\": \"<string>\",\n \"sunshineConversationsChannelSecret\": \"<string>\",\n \"sunshineConversationsChannelUri\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updateContactProfileWithFacebookProfile\": true,\n \"voice\": \"<string>\",\n \"webhookEndpointAuthentication\": {},\n \"webhookUrl\": \"<string>\",\n \"skill\": {},\n \"persistentMenu\": {}\n },\n \"transformer\": {\n \"abortOnError\": true,\n \"transformer\": \"<string>\",\n \"transpiledTransformer\": \"<string>\",\n \"inputTransformerEnabled\": true,\n \"outputTransformerEnabled\": true,\n \"finalPingTransformerEnabled\": true,\n \"notifyTransformerEnabled\": true,\n \"injectTransformerEnabled\": true\n },\n \"handoverSettings\": {\n \"providerSettings\": {\n \"forwardOnlyHandoverConversations\": true,\n \"getQueueUpdates\": true,\n \"apiVersion\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"apiAccessToken\": \"<string>\",\n \"baseApiUrl\": \"<string>\",\n \"realtimeAccessToken\": \"<string>\",\n \"realtimeEndpointUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"botCategoryId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"deploymentId\": \"<string>\",\n \"buttonId\": \"<string>\"\n },\n \"agentAssistSettings\": {\n \"agentAssistFlowId\": \"<string>\",\n \"agentAssistConfigId\": \"<string>\",\n \"enableTranscriptTile\": true,\n \"enableTranscriptTileChatInput\": true,\n \"redactTranscriptTileMessages\": true,\n \"enableAgentCopilotAuthentication\": true,\n \"blockNonJWTRequests\": true,\n \"agentCopilotAuthentication\": \"<string>\",\n \"copilotAuthenticationPublicKeys\": [\n \"<string>\"\n ],\n \"copilotAuthenticationKeyStoreUrl\": \"<string>\",\n \"oAuth2Connection\": \"<string>\"\n }\n },\n \"orgDataPrivacySettings\": {\n \"enabled\": true,\n \"useAnalytics\": true,\n \"storeDataPayload\": true,\n \"useContactProfiles\": true,\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"type": "Method Not Allowed",
"title": "Method Not Allowed Error",
"status": 405,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Conflict",
"title": "Conflict Error",
"status": 409,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1004,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payload Too Large",
"title": "Payload Too Large Error",
"status": 413,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Internal Server Error",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Implemented",
"title": "Not Implemented Error",
"status": 501,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1009,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Bad Gateway",
"title": "Bad Gateway Error",
"status": 502,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Service Unavailable",
"title": "Service Unavailable Error",
"status": 503,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 503,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Gateway Timeout",
"title": "Gateway Timeout Error",
"status": 504,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}Authorizations
Supply the API Key in the HTTP-Header
Headers
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.
application/json, application/hal+json, application/xml, text/xml, text/csv Path Parameters
The Id of the Endpoint
24^[a-z0-9]{24}$Body
facebook, alexa, slack, generic, inject, rest, realtime, socket, adminconsole, webchat2, dialogflow, twilio, twilio-sms, line, intercom, microsoftBotFramework, microsoftTeams, sunshineConversations, admin-webchat, avaya, nonConversational, voiceGateway2, amazonLex, workplace, webhook, abstractRest, userlike, ringCentralEngage, audioCodes, bandwidth, whatsapp, eightByEight, genesysBotConnector, niceCXOne, agentAssistVoice, webchat3, niceCXOneAAH, zoomContactCenter, mcpServer "webchat3"
The URLToken of the endpoint
"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f"
The name of the endpoint
"New Endpoint"
The ID can be either a Snapshot ID or a Project ID. The Endpoint will refer to the chosen one.
"667ed4ae16d66f47dc2a9400"
Toggle whether the endpoint is active or not
The NLU Connector type.
alexa, dialogflow, dialogflowBuiltIn, amazonLexBuiltIn, luis, watson, noNlu, cognigy, code, generativeAI, lex "cognigy"
Whether to collect conversations history for this endpoint
Whether to mask sensitive IP address in input object and analytics data for this endpoint
Whether to mask sensitive data in analytics for this endpoint
Whether to mask sensitive data in logs for this endpoint
Whether to use contact profiles for this endpoint
Whether we should store analytics for this endpoint
Whether we should use Dashbot to collect analytics
The apikey for the dashbot bot
If true, disables input text sanitization after Input Transformer
If true, disables skipping of uri tags
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Organisation data privacy settings overwrite the ones defined on endpoint-level
Show child attributes
Show child attributes
Response
The Endpoint was updated successfully.
curl --request PATCH \
--url https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": true,
"nluConnectorId": "cognigy",
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true,
"useContactProfiles": true,
"useAnalytics": true,
"useDashbotAnalytics": true,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": true,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": true,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": true,
"disableInputAutocomplete": true,
"disableInputAutogrow": true,
"disableUrlButtonSanitization": true,
"enableGenericHTMLStyling": true,
"enableAsyncCommunication": true,
"engagementMessageText": "<string>",
"displayGetStartedButton": true,
"dynamicImageAspectRatio": true,
"enableCollectMetadata": true,
"enableConnectionStatusIndicator": true,
"enableDemoWebchat": true,
"enableFileUpload": true,
"enablePersistentMenu": true,
"enableSTT": true,
"enableTTS": true,
"enableUnreadMessageBadge": true,
"enableUnreadMessagePreview": true,
"enableUnreadMessageSound": true,
"enableUnreadMessageTitleIndicator": true,
"enableTypingIndicator": true,
"facebookPageToken": "<string>",
"focusInputAfterPostback": true,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": true,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": true,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": true,
"requestFacebookProfileData": true,
"restEndpointAuthentication": {},
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": true,
"showEngagementMessagesInChat": true,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": true,
"voice": "<string>",
"webhookEndpointAuthentication": {},
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": true,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": true,
"outputTransformerEnabled": true,
"finalPingTransformerEnabled": true,
"notifyTransformerEnabled": true,
"injectTransformerEnabled": true
},
"handoverSettings": {
"providerSettings": {
"forwardOnlyHandoverConversations": true,
"getQueueUpdates": true,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": true,
"enableTranscriptTileChatInput": true,
"redactTranscriptTileMessages": true,
"enableAgentCopilotAuthentication": true,
"blockNonJWTRequests": true,
"agentCopilotAuthentication": "<string>",
"copilotAuthenticationPublicKeys": [
"<string>"
],
"copilotAuthenticationKeyStoreUrl": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": true,
"useAnalytics": true,
"storeDataPayload": true,
"useContactProfiles": true,
"useConversations": true,
"maskIPAddress": true,
"maskAnalytics": true,
"maskLogging": true
}
}
'import requests
url = "https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}"
payload = {
"foreignId": "<string>",
"channel": "webchat3",
"flowId": "<string>",
"localeId": "<string>",
"URLToken": "f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f",
"name": "New Endpoint",
"entrypoint": "667ed4ae16d66f47dc2a9400",
"active": True,
"nluConnectorId": "cognigy",
"useConversations": True,
"maskIPAddress": True,
"maskAnalytics": True,
"maskLogging": True,
"useContactProfiles": True,
"useAnalytics": True,
"useDashbotAnalytics": True,
"dashbotApikey": "<string>",
"dashbotPlatform": "<string>",
"disableInputSanitization": "<string>",
"disableSkipUriTags": "<string>",
"overrideSnapshotConnections": True,
"settings": {
"accessScope": "<string>",
"accessToken": "<string>",
"appId": "<string>",
"appSecret": "<string>",
"backgroundImageUrl": "<string>",
"basicAuthPassword": "<string>",
"basicAuthUser": "<string>",
"botUserId": "<string>",
"businessHours": {
"businessHours": [
{
"startTime": "<string>",
"endTime": "<string>",
"weekDay": "<string>"
}
],
"enabled": True,
"text": "<string>",
"mode": "<string>",
"timeZone": "<string>",
"title": "<string>"
},
"colorScheme": "<string>",
"connectionName": "<string>",
"customJSON": "<string>",
"designTemplate": 123,
"disableHtmlContentSanitization": True,
"disableInputAutocomplete": True,
"disableInputAutogrow": True,
"disableUrlButtonSanitization": True,
"enableGenericHTMLStyling": True,
"enableAsyncCommunication": True,
"engagementMessageText": "<string>",
"displayGetStartedButton": True,
"dynamicImageAspectRatio": True,
"enableCollectMetadata": True,
"enableConnectionStatusIndicator": True,
"enableDemoWebchat": True,
"enableFileUpload": True,
"enablePersistentMenu": True,
"enableSTT": True,
"enableTTS": True,
"enableUnreadMessageBadge": True,
"enableUnreadMessagePreview": True,
"enableUnreadMessageSound": True,
"enableUnreadMessageTitleIndicator": True,
"enableTypingIndicator": True,
"facebookPageToken": "<string>",
"focusInputAfterPostback": True,
"getStartedButtonText": "<string>",
"getStartedPayload": "<string>",
"getStartedText": "<string>",
"getStartedData": "<string>",
"headerLogoUrl": "<string>",
"hubSecret": "<string>",
"inputAutogrowMaxRows": 123,
"inputPlaceholder": "<string>",
"language": "<string>",
"lineChannelAccessToken": "<string>",
"lineChannelSecret": "<string>",
"maintenance": {
"enabled": True,
"mode": "<string>",
"text": "<string>",
"title": "<string>"
},
"mergeContactProfiles": True,
"messageDelay": 123,
"messageLogoUrl": "<string>",
"overwriteWebchatBundleUrl": "<string>",
"ratingTitleText": "<string>",
"ratingCommentText": "<string>",
"ratingMessageHistoryRatingText": "<string>",
"ratingMessageHistoryCommentText": "<string>",
"reparseAlexaSlots": True,
"requestFacebookProfileData": True,
"restEndpointAuthentication": {},
"sessionExpiration": 123,
"shouldOverwriteWebchatBundleUrl": True,
"showEngagementMessagesInChat": True,
"slackOAuthAccessToken": "<string>",
"slackVerifyToken": "<string>",
"sunshineConversationsChannelKeyId": "<string>",
"sunshineConversationsChannelSecret": "<string>",
"sunshineConversationsChannelUri": "<string>",
"tenantId": "<string>",
"updateContactProfileWithFacebookProfile": True,
"voice": "<string>",
"webhookEndpointAuthentication": {},
"webhookUrl": "<string>",
"skill": {},
"persistentMenu": {}
},
"transformer": {
"abortOnError": True,
"transformer": "<string>",
"transpiledTransformer": "<string>",
"inputTransformerEnabled": True,
"outputTransformerEnabled": True,
"finalPingTransformerEnabled": True,
"notifyTransformerEnabled": True,
"injectTransformerEnabled": True
},
"handoverSettings": {
"providerSettings": {
"forwardOnlyHandoverConversations": True,
"getQueueUpdates": True,
"apiVersion": "<string>",
"baseUrl": "<string>",
"apiAccessToken": "<string>",
"baseApiUrl": "<string>",
"realtimeAccessToken": "<string>",
"realtimeEndpointUrl": "<string>",
"webhookSecret": "<string>",
"botCategoryId": "<string>",
"agentCategoryId": "<string>",
"organizationId": "<string>",
"deploymentId": "<string>",
"buttonId": "<string>"
},
"agentAssistSettings": {
"agentAssistFlowId": "<string>",
"agentAssistConfigId": "<string>",
"enableTranscriptTile": True,
"enableTranscriptTileChatInput": True,
"redactTranscriptTileMessages": True,
"enableAgentCopilotAuthentication": True,
"blockNonJWTRequests": True,
"agentCopilotAuthentication": "<string>",
"copilotAuthenticationPublicKeys": ["<string>"],
"copilotAuthenticationKeyStoreUrl": "<string>",
"oAuth2Connection": "<string>"
}
},
"orgDataPrivacySettings": {
"enabled": True,
"useAnalytics": True,
"storeDataPayload": True,
"useContactProfiles": True,
"useConversations": True,
"maskIPAddress": True,
"maskAnalytics": True,
"maskLogging": True
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
foreignId: '<string>',
channel: 'webchat3',
flowId: '<string>',
localeId: '<string>',
URLToken: 'f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f',
name: 'New Endpoint',
entrypoint: '667ed4ae16d66f47dc2a9400',
active: true,
nluConnectorId: 'cognigy',
useConversations: true,
maskIPAddress: true,
maskAnalytics: true,
maskLogging: true,
useContactProfiles: true,
useAnalytics: true,
useDashbotAnalytics: true,
dashbotApikey: '<string>',
dashbotPlatform: '<string>',
disableInputSanitization: '<string>',
disableSkipUriTags: '<string>',
overrideSnapshotConnections: true,
settings: {
accessScope: '<string>',
accessToken: '<string>',
appId: '<string>',
appSecret: '<string>',
backgroundImageUrl: '<string>',
basicAuthPassword: '<string>',
basicAuthUser: '<string>',
botUserId: '<string>',
businessHours: {
businessHours: [{startTime: '<string>', endTime: '<string>', weekDay: '<string>'}],
enabled: true,
text: '<string>',
mode: '<string>',
timeZone: '<string>',
title: '<string>'
},
colorScheme: '<string>',
connectionName: '<string>',
customJSON: '<string>',
designTemplate: 123,
disableHtmlContentSanitization: true,
disableInputAutocomplete: true,
disableInputAutogrow: true,
disableUrlButtonSanitization: true,
enableGenericHTMLStyling: true,
enableAsyncCommunication: true,
engagementMessageText: '<string>',
displayGetStartedButton: true,
dynamicImageAspectRatio: true,
enableCollectMetadata: true,
enableConnectionStatusIndicator: true,
enableDemoWebchat: true,
enableFileUpload: true,
enablePersistentMenu: true,
enableSTT: true,
enableTTS: true,
enableUnreadMessageBadge: true,
enableUnreadMessagePreview: true,
enableUnreadMessageSound: true,
enableUnreadMessageTitleIndicator: true,
enableTypingIndicator: true,
facebookPageToken: '<string>',
focusInputAfterPostback: true,
getStartedButtonText: '<string>',
getStartedPayload: '<string>',
getStartedText: '<string>',
getStartedData: '<string>',
headerLogoUrl: '<string>',
hubSecret: '<string>',
inputAutogrowMaxRows: 123,
inputPlaceholder: '<string>',
language: '<string>',
lineChannelAccessToken: '<string>',
lineChannelSecret: '<string>',
maintenance: {enabled: true, mode: '<string>', text: '<string>', title: '<string>'},
mergeContactProfiles: true,
messageDelay: 123,
messageLogoUrl: '<string>',
overwriteWebchatBundleUrl: '<string>',
ratingTitleText: '<string>',
ratingCommentText: '<string>',
ratingMessageHistoryRatingText: '<string>',
ratingMessageHistoryCommentText: '<string>',
reparseAlexaSlots: true,
requestFacebookProfileData: true,
restEndpointAuthentication: {},
sessionExpiration: 123,
shouldOverwriteWebchatBundleUrl: true,
showEngagementMessagesInChat: true,
slackOAuthAccessToken: '<string>',
slackVerifyToken: '<string>',
sunshineConversationsChannelKeyId: '<string>',
sunshineConversationsChannelSecret: '<string>',
sunshineConversationsChannelUri: '<string>',
tenantId: '<string>',
updateContactProfileWithFacebookProfile: true,
voice: '<string>',
webhookEndpointAuthentication: {},
webhookUrl: '<string>',
skill: {},
persistentMenu: {}
},
transformer: {
abortOnError: true,
transformer: '<string>',
transpiledTransformer: '<string>',
inputTransformerEnabled: true,
outputTransformerEnabled: true,
finalPingTransformerEnabled: true,
notifyTransformerEnabled: true,
injectTransformerEnabled: true
},
handoverSettings: {
providerSettings: {
forwardOnlyHandoverConversations: true,
getQueueUpdates: true,
apiVersion: '<string>',
baseUrl: '<string>',
apiAccessToken: '<string>',
baseApiUrl: '<string>',
realtimeAccessToken: '<string>',
realtimeEndpointUrl: '<string>',
webhookSecret: '<string>',
botCategoryId: '<string>',
agentCategoryId: '<string>',
organizationId: '<string>',
deploymentId: '<string>',
buttonId: '<string>'
},
agentAssistSettings: {
agentAssistFlowId: '<string>',
agentAssistConfigId: '<string>',
enableTranscriptTile: true,
enableTranscriptTileChatInput: true,
redactTranscriptTileMessages: true,
enableAgentCopilotAuthentication: true,
blockNonJWTRequests: true,
agentCopilotAuthentication: '<string>',
copilotAuthenticationPublicKeys: ['<string>'],
copilotAuthenticationKeyStoreUrl: '<string>',
oAuth2Connection: '<string>'
}
},
orgDataPrivacySettings: {
enabled: true,
useAnalytics: true,
storeDataPayload: true,
useContactProfiles: true,
useConversations: true,
maskIPAddress: true,
maskAnalytics: true,
maskLogging: true
}
})
};
fetch('https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}', 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/endpoints/{endpointId}",
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([
'foreignId' => '<string>',
'channel' => 'webchat3',
'flowId' => '<string>',
'localeId' => '<string>',
'URLToken' => 'f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f',
'name' => 'New Endpoint',
'entrypoint' => '667ed4ae16d66f47dc2a9400',
'active' => true,
'nluConnectorId' => 'cognigy',
'useConversations' => true,
'maskIPAddress' => true,
'maskAnalytics' => true,
'maskLogging' => true,
'useContactProfiles' => true,
'useAnalytics' => true,
'useDashbotAnalytics' => true,
'dashbotApikey' => '<string>',
'dashbotPlatform' => '<string>',
'disableInputSanitization' => '<string>',
'disableSkipUriTags' => '<string>',
'overrideSnapshotConnections' => true,
'settings' => [
'accessScope' => '<string>',
'accessToken' => '<string>',
'appId' => '<string>',
'appSecret' => '<string>',
'backgroundImageUrl' => '<string>',
'basicAuthPassword' => '<string>',
'basicAuthUser' => '<string>',
'botUserId' => '<string>',
'businessHours' => [
'businessHours' => [
[
'startTime' => '<string>',
'endTime' => '<string>',
'weekDay' => '<string>'
]
],
'enabled' => true,
'text' => '<string>',
'mode' => '<string>',
'timeZone' => '<string>',
'title' => '<string>'
],
'colorScheme' => '<string>',
'connectionName' => '<string>',
'customJSON' => '<string>',
'designTemplate' => 123,
'disableHtmlContentSanitization' => true,
'disableInputAutocomplete' => true,
'disableInputAutogrow' => true,
'disableUrlButtonSanitization' => true,
'enableGenericHTMLStyling' => true,
'enableAsyncCommunication' => true,
'engagementMessageText' => '<string>',
'displayGetStartedButton' => true,
'dynamicImageAspectRatio' => true,
'enableCollectMetadata' => true,
'enableConnectionStatusIndicator' => true,
'enableDemoWebchat' => true,
'enableFileUpload' => true,
'enablePersistentMenu' => true,
'enableSTT' => true,
'enableTTS' => true,
'enableUnreadMessageBadge' => true,
'enableUnreadMessagePreview' => true,
'enableUnreadMessageSound' => true,
'enableUnreadMessageTitleIndicator' => true,
'enableTypingIndicator' => true,
'facebookPageToken' => '<string>',
'focusInputAfterPostback' => true,
'getStartedButtonText' => '<string>',
'getStartedPayload' => '<string>',
'getStartedText' => '<string>',
'getStartedData' => '<string>',
'headerLogoUrl' => '<string>',
'hubSecret' => '<string>',
'inputAutogrowMaxRows' => 123,
'inputPlaceholder' => '<string>',
'language' => '<string>',
'lineChannelAccessToken' => '<string>',
'lineChannelSecret' => '<string>',
'maintenance' => [
'enabled' => true,
'mode' => '<string>',
'text' => '<string>',
'title' => '<string>'
],
'mergeContactProfiles' => true,
'messageDelay' => 123,
'messageLogoUrl' => '<string>',
'overwriteWebchatBundleUrl' => '<string>',
'ratingTitleText' => '<string>',
'ratingCommentText' => '<string>',
'ratingMessageHistoryRatingText' => '<string>',
'ratingMessageHistoryCommentText' => '<string>',
'reparseAlexaSlots' => true,
'requestFacebookProfileData' => true,
'restEndpointAuthentication' => [
],
'sessionExpiration' => 123,
'shouldOverwriteWebchatBundleUrl' => true,
'showEngagementMessagesInChat' => true,
'slackOAuthAccessToken' => '<string>',
'slackVerifyToken' => '<string>',
'sunshineConversationsChannelKeyId' => '<string>',
'sunshineConversationsChannelSecret' => '<string>',
'sunshineConversationsChannelUri' => '<string>',
'tenantId' => '<string>',
'updateContactProfileWithFacebookProfile' => true,
'voice' => '<string>',
'webhookEndpointAuthentication' => [
],
'webhookUrl' => '<string>',
'skill' => [
],
'persistentMenu' => [
]
],
'transformer' => [
'abortOnError' => true,
'transformer' => '<string>',
'transpiledTransformer' => '<string>',
'inputTransformerEnabled' => true,
'outputTransformerEnabled' => true,
'finalPingTransformerEnabled' => true,
'notifyTransformerEnabled' => true,
'injectTransformerEnabled' => true
],
'handoverSettings' => [
'providerSettings' => [
'forwardOnlyHandoverConversations' => true,
'getQueueUpdates' => true,
'apiVersion' => '<string>',
'baseUrl' => '<string>',
'apiAccessToken' => '<string>',
'baseApiUrl' => '<string>',
'realtimeAccessToken' => '<string>',
'realtimeEndpointUrl' => '<string>',
'webhookSecret' => '<string>',
'botCategoryId' => '<string>',
'agentCategoryId' => '<string>',
'organizationId' => '<string>',
'deploymentId' => '<string>',
'buttonId' => '<string>'
],
'agentAssistSettings' => [
'agentAssistFlowId' => '<string>',
'agentAssistConfigId' => '<string>',
'enableTranscriptTile' => true,
'enableTranscriptTileChatInput' => true,
'redactTranscriptTileMessages' => true,
'enableAgentCopilotAuthentication' => true,
'blockNonJWTRequests' => true,
'agentCopilotAuthentication' => '<string>',
'copilotAuthenticationPublicKeys' => [
'<string>'
],
'copilotAuthenticationKeyStoreUrl' => '<string>',
'oAuth2Connection' => '<string>'
]
],
'orgDataPrivacySettings' => [
'enabled' => true,
'useAnalytics' => true,
'storeDataPayload' => true,
'useContactProfiles' => true,
'useConversations' => true,
'maskIPAddress' => true,
'maskAnalytics' => true,
'maskLogging' => true
]
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}"
payload := strings.NewReader("{\n \"foreignId\": \"<string>\",\n \"channel\": \"webchat3\",\n \"flowId\": \"<string>\",\n \"localeId\": \"<string>\",\n \"URLToken\": \"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f\",\n \"name\": \"New Endpoint\",\n \"entrypoint\": \"667ed4ae16d66f47dc2a9400\",\n \"active\": true,\n \"nluConnectorId\": \"cognigy\",\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true,\n \"useContactProfiles\": true,\n \"useAnalytics\": true,\n \"useDashbotAnalytics\": true,\n \"dashbotApikey\": \"<string>\",\n \"dashbotPlatform\": \"<string>\",\n \"disableInputSanitization\": \"<string>\",\n \"disableSkipUriTags\": \"<string>\",\n \"overrideSnapshotConnections\": true,\n \"settings\": {\n \"accessScope\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"appId\": \"<string>\",\n \"appSecret\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"basicAuthPassword\": \"<string>\",\n \"basicAuthUser\": \"<string>\",\n \"botUserId\": \"<string>\",\n \"businessHours\": {\n \"businessHours\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"weekDay\": \"<string>\"\n }\n ],\n \"enabled\": true,\n \"text\": \"<string>\",\n \"mode\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"colorScheme\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"customJSON\": \"<string>\",\n \"designTemplate\": 123,\n \"disableHtmlContentSanitization\": true,\n \"disableInputAutocomplete\": true,\n \"disableInputAutogrow\": true,\n \"disableUrlButtonSanitization\": true,\n \"enableGenericHTMLStyling\": true,\n \"enableAsyncCommunication\": true,\n \"engagementMessageText\": \"<string>\",\n \"displayGetStartedButton\": true,\n \"dynamicImageAspectRatio\": true,\n \"enableCollectMetadata\": true,\n \"enableConnectionStatusIndicator\": true,\n \"enableDemoWebchat\": true,\n \"enableFileUpload\": true,\n \"enablePersistentMenu\": true,\n \"enableSTT\": true,\n \"enableTTS\": true,\n \"enableUnreadMessageBadge\": true,\n \"enableUnreadMessagePreview\": true,\n \"enableUnreadMessageSound\": true,\n \"enableUnreadMessageTitleIndicator\": true,\n \"enableTypingIndicator\": true,\n \"facebookPageToken\": \"<string>\",\n \"focusInputAfterPostback\": true,\n \"getStartedButtonText\": \"<string>\",\n \"getStartedPayload\": \"<string>\",\n \"getStartedText\": \"<string>\",\n \"getStartedData\": \"<string>\",\n \"headerLogoUrl\": \"<string>\",\n \"hubSecret\": \"<string>\",\n \"inputAutogrowMaxRows\": 123,\n \"inputPlaceholder\": \"<string>\",\n \"language\": \"<string>\",\n \"lineChannelAccessToken\": \"<string>\",\n \"lineChannelSecret\": \"<string>\",\n \"maintenance\": {\n \"enabled\": true,\n \"mode\": \"<string>\",\n \"text\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"mergeContactProfiles\": true,\n \"messageDelay\": 123,\n \"messageLogoUrl\": \"<string>\",\n \"overwriteWebchatBundleUrl\": \"<string>\",\n \"ratingTitleText\": \"<string>\",\n \"ratingCommentText\": \"<string>\",\n \"ratingMessageHistoryRatingText\": \"<string>\",\n \"ratingMessageHistoryCommentText\": \"<string>\",\n \"reparseAlexaSlots\": true,\n \"requestFacebookProfileData\": true,\n \"restEndpointAuthentication\": {},\n \"sessionExpiration\": 123,\n \"shouldOverwriteWebchatBundleUrl\": true,\n \"showEngagementMessagesInChat\": true,\n \"slackOAuthAccessToken\": \"<string>\",\n \"slackVerifyToken\": \"<string>\",\n \"sunshineConversationsChannelKeyId\": \"<string>\",\n \"sunshineConversationsChannelSecret\": \"<string>\",\n \"sunshineConversationsChannelUri\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updateContactProfileWithFacebookProfile\": true,\n \"voice\": \"<string>\",\n \"webhookEndpointAuthentication\": {},\n \"webhookUrl\": \"<string>\",\n \"skill\": {},\n \"persistentMenu\": {}\n },\n \"transformer\": {\n \"abortOnError\": true,\n \"transformer\": \"<string>\",\n \"transpiledTransformer\": \"<string>\",\n \"inputTransformerEnabled\": true,\n \"outputTransformerEnabled\": true,\n \"finalPingTransformerEnabled\": true,\n \"notifyTransformerEnabled\": true,\n \"injectTransformerEnabled\": true\n },\n \"handoverSettings\": {\n \"providerSettings\": {\n \"forwardOnlyHandoverConversations\": true,\n \"getQueueUpdates\": true,\n \"apiVersion\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"apiAccessToken\": \"<string>\",\n \"baseApiUrl\": \"<string>\",\n \"realtimeAccessToken\": \"<string>\",\n \"realtimeEndpointUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"botCategoryId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"deploymentId\": \"<string>\",\n \"buttonId\": \"<string>\"\n },\n \"agentAssistSettings\": {\n \"agentAssistFlowId\": \"<string>\",\n \"agentAssistConfigId\": \"<string>\",\n \"enableTranscriptTile\": true,\n \"enableTranscriptTileChatInput\": true,\n \"redactTranscriptTileMessages\": true,\n \"enableAgentCopilotAuthentication\": true,\n \"blockNonJWTRequests\": true,\n \"agentCopilotAuthentication\": \"<string>\",\n \"copilotAuthenticationPublicKeys\": [\n \"<string>\"\n ],\n \"copilotAuthenticationKeyStoreUrl\": \"<string>\",\n \"oAuth2Connection\": \"<string>\"\n }\n },\n \"orgDataPrivacySettings\": {\n \"enabled\": true,\n \"useAnalytics\": true,\n \"storeDataPayload\": true,\n \"useContactProfiles\": true,\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true\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))
}HttpResponse<String> response = Unirest.patch("https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"foreignId\": \"<string>\",\n \"channel\": \"webchat3\",\n \"flowId\": \"<string>\",\n \"localeId\": \"<string>\",\n \"URLToken\": \"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f\",\n \"name\": \"New Endpoint\",\n \"entrypoint\": \"667ed4ae16d66f47dc2a9400\",\n \"active\": true,\n \"nluConnectorId\": \"cognigy\",\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true,\n \"useContactProfiles\": true,\n \"useAnalytics\": true,\n \"useDashbotAnalytics\": true,\n \"dashbotApikey\": \"<string>\",\n \"dashbotPlatform\": \"<string>\",\n \"disableInputSanitization\": \"<string>\",\n \"disableSkipUriTags\": \"<string>\",\n \"overrideSnapshotConnections\": true,\n \"settings\": {\n \"accessScope\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"appId\": \"<string>\",\n \"appSecret\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"basicAuthPassword\": \"<string>\",\n \"basicAuthUser\": \"<string>\",\n \"botUserId\": \"<string>\",\n \"businessHours\": {\n \"businessHours\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"weekDay\": \"<string>\"\n }\n ],\n \"enabled\": true,\n \"text\": \"<string>\",\n \"mode\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"colorScheme\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"customJSON\": \"<string>\",\n \"designTemplate\": 123,\n \"disableHtmlContentSanitization\": true,\n \"disableInputAutocomplete\": true,\n \"disableInputAutogrow\": true,\n \"disableUrlButtonSanitization\": true,\n \"enableGenericHTMLStyling\": true,\n \"enableAsyncCommunication\": true,\n \"engagementMessageText\": \"<string>\",\n \"displayGetStartedButton\": true,\n \"dynamicImageAspectRatio\": true,\n \"enableCollectMetadata\": true,\n \"enableConnectionStatusIndicator\": true,\n \"enableDemoWebchat\": true,\n \"enableFileUpload\": true,\n \"enablePersistentMenu\": true,\n \"enableSTT\": true,\n \"enableTTS\": true,\n \"enableUnreadMessageBadge\": true,\n \"enableUnreadMessagePreview\": true,\n \"enableUnreadMessageSound\": true,\n \"enableUnreadMessageTitleIndicator\": true,\n \"enableTypingIndicator\": true,\n \"facebookPageToken\": \"<string>\",\n \"focusInputAfterPostback\": true,\n \"getStartedButtonText\": \"<string>\",\n \"getStartedPayload\": \"<string>\",\n \"getStartedText\": \"<string>\",\n \"getStartedData\": \"<string>\",\n \"headerLogoUrl\": \"<string>\",\n \"hubSecret\": \"<string>\",\n \"inputAutogrowMaxRows\": 123,\n \"inputPlaceholder\": \"<string>\",\n \"language\": \"<string>\",\n \"lineChannelAccessToken\": \"<string>\",\n \"lineChannelSecret\": \"<string>\",\n \"maintenance\": {\n \"enabled\": true,\n \"mode\": \"<string>\",\n \"text\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"mergeContactProfiles\": true,\n \"messageDelay\": 123,\n \"messageLogoUrl\": \"<string>\",\n \"overwriteWebchatBundleUrl\": \"<string>\",\n \"ratingTitleText\": \"<string>\",\n \"ratingCommentText\": \"<string>\",\n \"ratingMessageHistoryRatingText\": \"<string>\",\n \"ratingMessageHistoryCommentText\": \"<string>\",\n \"reparseAlexaSlots\": true,\n \"requestFacebookProfileData\": true,\n \"restEndpointAuthentication\": {},\n \"sessionExpiration\": 123,\n \"shouldOverwriteWebchatBundleUrl\": true,\n \"showEngagementMessagesInChat\": true,\n \"slackOAuthAccessToken\": \"<string>\",\n \"slackVerifyToken\": \"<string>\",\n \"sunshineConversationsChannelKeyId\": \"<string>\",\n \"sunshineConversationsChannelSecret\": \"<string>\",\n \"sunshineConversationsChannelUri\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updateContactProfileWithFacebookProfile\": true,\n \"voice\": \"<string>\",\n \"webhookEndpointAuthentication\": {},\n \"webhookUrl\": \"<string>\",\n \"skill\": {},\n \"persistentMenu\": {}\n },\n \"transformer\": {\n \"abortOnError\": true,\n \"transformer\": \"<string>\",\n \"transpiledTransformer\": \"<string>\",\n \"inputTransformerEnabled\": true,\n \"outputTransformerEnabled\": true,\n \"finalPingTransformerEnabled\": true,\n \"notifyTransformerEnabled\": true,\n \"injectTransformerEnabled\": true\n },\n \"handoverSettings\": {\n \"providerSettings\": {\n \"forwardOnlyHandoverConversations\": true,\n \"getQueueUpdates\": true,\n \"apiVersion\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"apiAccessToken\": \"<string>\",\n \"baseApiUrl\": \"<string>\",\n \"realtimeAccessToken\": \"<string>\",\n \"realtimeEndpointUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"botCategoryId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"deploymentId\": \"<string>\",\n \"buttonId\": \"<string>\"\n },\n \"agentAssistSettings\": {\n \"agentAssistFlowId\": \"<string>\",\n \"agentAssistConfigId\": \"<string>\",\n \"enableTranscriptTile\": true,\n \"enableTranscriptTileChatInput\": true,\n \"redactTranscriptTileMessages\": true,\n \"enableAgentCopilotAuthentication\": true,\n \"blockNonJWTRequests\": true,\n \"agentCopilotAuthentication\": \"<string>\",\n \"copilotAuthenticationPublicKeys\": [\n \"<string>\"\n ],\n \"copilotAuthenticationKeyStoreUrl\": \"<string>\",\n \"oAuth2Connection\": \"<string>\"\n }\n },\n \"orgDataPrivacySettings\": {\n \"enabled\": true,\n \"useAnalytics\": true,\n \"storeDataPayload\": true,\n \"useContactProfiles\": true,\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-trial.cognigy.ai/new/v2.0/endpoints/{endpointId}")
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 \"foreignId\": \"<string>\",\n \"channel\": \"webchat3\",\n \"flowId\": \"<string>\",\n \"localeId\": \"<string>\",\n \"URLToken\": \"f65b289912c929c2a09523dd48eedb1249bb74384f6561f84b4ffc5e84d2f15f\",\n \"name\": \"New Endpoint\",\n \"entrypoint\": \"667ed4ae16d66f47dc2a9400\",\n \"active\": true,\n \"nluConnectorId\": \"cognigy\",\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true,\n \"useContactProfiles\": true,\n \"useAnalytics\": true,\n \"useDashbotAnalytics\": true,\n \"dashbotApikey\": \"<string>\",\n \"dashbotPlatform\": \"<string>\",\n \"disableInputSanitization\": \"<string>\",\n \"disableSkipUriTags\": \"<string>\",\n \"overrideSnapshotConnections\": true,\n \"settings\": {\n \"accessScope\": \"<string>\",\n \"accessToken\": \"<string>\",\n \"appId\": \"<string>\",\n \"appSecret\": \"<string>\",\n \"backgroundImageUrl\": \"<string>\",\n \"basicAuthPassword\": \"<string>\",\n \"basicAuthUser\": \"<string>\",\n \"botUserId\": \"<string>\",\n \"businessHours\": {\n \"businessHours\": [\n {\n \"startTime\": \"<string>\",\n \"endTime\": \"<string>\",\n \"weekDay\": \"<string>\"\n }\n ],\n \"enabled\": true,\n \"text\": \"<string>\",\n \"mode\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"colorScheme\": \"<string>\",\n \"connectionName\": \"<string>\",\n \"customJSON\": \"<string>\",\n \"designTemplate\": 123,\n \"disableHtmlContentSanitization\": true,\n \"disableInputAutocomplete\": true,\n \"disableInputAutogrow\": true,\n \"disableUrlButtonSanitization\": true,\n \"enableGenericHTMLStyling\": true,\n \"enableAsyncCommunication\": true,\n \"engagementMessageText\": \"<string>\",\n \"displayGetStartedButton\": true,\n \"dynamicImageAspectRatio\": true,\n \"enableCollectMetadata\": true,\n \"enableConnectionStatusIndicator\": true,\n \"enableDemoWebchat\": true,\n \"enableFileUpload\": true,\n \"enablePersistentMenu\": true,\n \"enableSTT\": true,\n \"enableTTS\": true,\n \"enableUnreadMessageBadge\": true,\n \"enableUnreadMessagePreview\": true,\n \"enableUnreadMessageSound\": true,\n \"enableUnreadMessageTitleIndicator\": true,\n \"enableTypingIndicator\": true,\n \"facebookPageToken\": \"<string>\",\n \"focusInputAfterPostback\": true,\n \"getStartedButtonText\": \"<string>\",\n \"getStartedPayload\": \"<string>\",\n \"getStartedText\": \"<string>\",\n \"getStartedData\": \"<string>\",\n \"headerLogoUrl\": \"<string>\",\n \"hubSecret\": \"<string>\",\n \"inputAutogrowMaxRows\": 123,\n \"inputPlaceholder\": \"<string>\",\n \"language\": \"<string>\",\n \"lineChannelAccessToken\": \"<string>\",\n \"lineChannelSecret\": \"<string>\",\n \"maintenance\": {\n \"enabled\": true,\n \"mode\": \"<string>\",\n \"text\": \"<string>\",\n \"title\": \"<string>\"\n },\n \"mergeContactProfiles\": true,\n \"messageDelay\": 123,\n \"messageLogoUrl\": \"<string>\",\n \"overwriteWebchatBundleUrl\": \"<string>\",\n \"ratingTitleText\": \"<string>\",\n \"ratingCommentText\": \"<string>\",\n \"ratingMessageHistoryRatingText\": \"<string>\",\n \"ratingMessageHistoryCommentText\": \"<string>\",\n \"reparseAlexaSlots\": true,\n \"requestFacebookProfileData\": true,\n \"restEndpointAuthentication\": {},\n \"sessionExpiration\": 123,\n \"shouldOverwriteWebchatBundleUrl\": true,\n \"showEngagementMessagesInChat\": true,\n \"slackOAuthAccessToken\": \"<string>\",\n \"slackVerifyToken\": \"<string>\",\n \"sunshineConversationsChannelKeyId\": \"<string>\",\n \"sunshineConversationsChannelSecret\": \"<string>\",\n \"sunshineConversationsChannelUri\": \"<string>\",\n \"tenantId\": \"<string>\",\n \"updateContactProfileWithFacebookProfile\": true,\n \"voice\": \"<string>\",\n \"webhookEndpointAuthentication\": {},\n \"webhookUrl\": \"<string>\",\n \"skill\": {},\n \"persistentMenu\": {}\n },\n \"transformer\": {\n \"abortOnError\": true,\n \"transformer\": \"<string>\",\n \"transpiledTransformer\": \"<string>\",\n \"inputTransformerEnabled\": true,\n \"outputTransformerEnabled\": true,\n \"finalPingTransformerEnabled\": true,\n \"notifyTransformerEnabled\": true,\n \"injectTransformerEnabled\": true\n },\n \"handoverSettings\": {\n \"providerSettings\": {\n \"forwardOnlyHandoverConversations\": true,\n \"getQueueUpdates\": true,\n \"apiVersion\": \"<string>\",\n \"baseUrl\": \"<string>\",\n \"apiAccessToken\": \"<string>\",\n \"baseApiUrl\": \"<string>\",\n \"realtimeAccessToken\": \"<string>\",\n \"realtimeEndpointUrl\": \"<string>\",\n \"webhookSecret\": \"<string>\",\n \"botCategoryId\": \"<string>\",\n \"agentCategoryId\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"deploymentId\": \"<string>\",\n \"buttonId\": \"<string>\"\n },\n \"agentAssistSettings\": {\n \"agentAssistFlowId\": \"<string>\",\n \"agentAssistConfigId\": \"<string>\",\n \"enableTranscriptTile\": true,\n \"enableTranscriptTileChatInput\": true,\n \"redactTranscriptTileMessages\": true,\n \"enableAgentCopilotAuthentication\": true,\n \"blockNonJWTRequests\": true,\n \"agentCopilotAuthentication\": \"<string>\",\n \"copilotAuthenticationPublicKeys\": [\n \"<string>\"\n ],\n \"copilotAuthenticationKeyStoreUrl\": \"<string>\",\n \"oAuth2Connection\": \"<string>\"\n }\n },\n \"orgDataPrivacySettings\": {\n \"enabled\": true,\n \"useAnalytics\": true,\n \"storeDataPayload\": true,\n \"useContactProfiles\": true,\n \"useConversations\": true,\n \"maskIPAddress\": true,\n \"maskAnalytics\": true,\n \"maskLogging\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"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"
}{
"type": "Method Not Allowed",
"title": "Method Not Allowed Error",
"status": 405,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Conflict",
"title": "Conflict Error",
"status": 409,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1004,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Payload Too Large",
"title": "Payload Too Large Error",
"status": 413,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Internal Server Error",
"title": "Internal Server Error",
"status": 500,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Not Implemented",
"title": "Not Implemented Error",
"status": 501,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1009,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Bad Gateway",
"title": "Bad Gateway Error",
"status": 502,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Service Unavailable",
"title": "Service Unavailable Error",
"status": 503,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 503,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}{
"type": "Gateway Timeout",
"title": "Gateway Timeout Error",
"status": 504,
"detail": "<string>",
"instance": "/v2.0/flows/5ce7c2d833ea1e04d7e6c432",
"code": 1000,
"traceId": "api--f84324f4-98eb-4f02-abdd-375a2e6c3c1f",
"details": {}
}