Create a new Form

You may create a form using this action.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

Organization ID of the owning organization. Defaults to the API user's active organization.

string
required

Name of the form

string
enum
Defaults to topic

Form type. A static form always stays active, while a topic is picked by the agent.

Allowed:
string

Form ID of the form that was used as a template.

profileFields
array

List of profile fields for this form

profileFields
fields
array

List of fields for this form

fields
notifyEmails
array

A list of email addresses where form results get sent to.

notifyEmails
string
enum
Defaults to active

State of the form. Archived forms are not made available in the UI.

Allowed:
tags
array

List of sharing tags for the form. The form will be made available to child organizations with matching tags.

tags
labels
array

List of labels for the form. Form labels will be passed on in conversation.forms, as well as conversation.results and in Results messages when the form is processed.

labels
number

Number of points when an agent submits a result with this form.

number

Number of points when a bot submits a result with this form.

meta
object

Free-form object of key-values, that will be passed on to external systems.

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json