Skip to navigation

Create rich text form

View as Markdown

Creates a rich text form 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.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
domainenumRequired

The business domain the form belongs to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.

form_idstringRequired1-1000 characters
Your unique identifier for the form. Must not duplicate another form's ID and cannot be changed after creation.
titlestringRequired1-1000 characters
The title of the form shown to users.
short_descriptionstringRequired1-1000 characters
A short description of the form.
versionobjectRequired
Document version. On update, send back the num from your last read.
descriptionstringOptional<=1000 characters
An optional longer description of the form. Up to 1000 characters.
fieldslist of objectsOptional
The input fields shown on the form.
update_ruleslist of objectsOptional
Rules that dynamically change field behavior on the form. Rules run in the order defined, so a later rule overrides an earlier one for the same field.

Response

The created rich text form
idstringOptionalRead-only
Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
domainenumOptional

The business domain the form belongs to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.

form_idstringOptional1-1000 characters
Your unique identifier for the form. Must not duplicate another form's ID and cannot be changed after creation.
titlestringOptional1-1000 characters
The title of the form shown to users.
short_descriptionstringOptional1-1000 characters
A short description of the form.
descriptionstringOptional<=1000 characters
An optional longer description of the form. Up to 1000 characters.
fieldslist of objectsOptional
The input fields shown on the form.
update_ruleslist of objectsOptional
Rules that dynamically change field behavior on the form. Rules run in the order defined, so a later rule overrides an earlier one for the same field.
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