Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Help us improve our product documentation on docs.cognigy.com by sharing your thoughts in a quick survey. Your feedback shapes the future of our content!
Create a State
Create a State in a Flow. Deprecated. The āStateā feature has been deprecated since 2026.7.0 and will be removed in an upcoming release.
curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/states \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "default",
"isDefault": true,
"type": "blacklist",
"intentIds": [
"<string>"
]
}
'{
"name": "default",
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isDefault": true,
"type": "blacklist",
"intentIds": [
"<string>"
],
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}Documentation Index
Fetch the complete documentation index at: https://docs.cognigy.com/llms.txt
Use this file to discover all available pages before exploring further.
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 unique identifier for the Flow.
24^[a-z0-9]{24}$Body
Response
Returns the State metadata object.
The IEntityMeta defines meta information every entity within the system has. These are dates when a resource was created and modified as well as information about the user who initially created a resource and who modified it the last time.
"default"
blacklist, whitelist "blacklist"
24^[a-z0-9]{24}$24^[a-z0-9]{24}$Unix-timestamp
0 <= x <= 21474836471694518620
Unix-timestamp
0 <= x <= 21474836471694518620
24^[a-z0-9]{24}$24^[a-z0-9]{24}$curl --request POST \
--url https://api-trial.cognigy.ai/new/v2.0/flows/{flowId}/states \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "default",
"isDefault": true,
"type": "blacklist",
"intentIds": [
"<string>"
]
}
'{
"name": "default",
"referenceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"isDefault": true,
"type": "blacklist",
"intentIds": [
"<string>"
],
"_id": "<string>",
"createdAt": 1694518620,
"lastChanged": 1694518620,
"createdBy": "<string>",
"lastChangedBy": "<string>"
}