Skip to navigation

Create conversational process

View as Markdown

Creates a conversational process and returns it with its server-assigned id and version.

Send the fields at the top level of the body. Don’t send id or version.num; version.change_description is required. Anything this conversational process refers to must already exist.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
signatureobjectRequired
Name and description of the conversational process. The internal name is derived from the display name. Required.
conversation_flowobjectRequired

The control flow of the process, built from sequential, switch, activity, return and no-op blocks. Required.

versionobjectRequired
Document version. On update, send back the num from your last read.
slotslist of objectsOptional

Input values (slots) the process collects from the user and uses as variables in the conversation flow.

Response

The created conversational process
idstringOptionalRead-only
Unique identifier of the conversational process, assigned by the server. Cannot be changed.
signatureobjectOptional
Name and description of the conversational process. The internal name is derived from the display name. Required.
slotslist of objectsOptional

Input values (slots) the process collects from the user and uses as variables in the conversation flow.

conversation_flowobjectOptional

The control flow of the process, built from sequential, switch, activity, return and no-op blocks. Required.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error