Skip to main content
PATCH
/
v2.0
/
flow
/
{flowId}
/
states
Perform Batch Operations on States
curl --request PATCH \
  --url 'https://api-trial.cognigy.ai/new/v2.0/flow/{flowId}/states?api_key=' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "operations": [
    {
      "op": "delete",
      "id": "<string>"
    }
  ]
}
'
{
  "created": [
    "<string>"
  ],
  "updated": [
    "<string>"
  ],
  "deleted": [
    "<string>"
  ]
}

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
ā€‹
operations
object[]

Response

Successfully ran the batch operations.

ā€‹
created
string[]
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
updated
string[]
Required string length: 24
Pattern: ^[a-z0-9]{24}$
ā€‹
deleted
string[]
Required string length: 24
Pattern: ^[a-z0-9]{24}$