Skip to main content
PATCH
/
v2.0
/
flows
/
{flowId}
Update a Flow
curl --request PATCH \
  --url 'https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "context": {},
  "attachedFlows": [
    "<string>"
  ],
  "attachedLexicons": [
    "<string>"
  ],
  "img": "<string>",
  "localeId": "<string>"
}
'
{
  "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

ā€‹
api_key
string
query
required

Supply the API Key in the Url-Query

ā€‹
Authorization
string
header
required

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

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

ā€‹
flowId
string
required

The Id of the Flow

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

Body

application/json
ā€‹
name
string
ā€‹
description
string
ā€‹
context
object
ā€‹
attachedFlows
string[]
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
attachedLexicons
string[]
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
img
string
ā€‹
localeId
string
Required string length: 24
Pattern: ^[a-z0-9]{24}$

Response

The Flow was successfully updated.