Update rich text form
Changes the fields you send and returns the full updated document.
Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The id goes in the URL; if you also send id in the body it must match.
Authentication
AuthorizationBearer
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Path parameters
id
The id of the rich text form, as returned when it was created or listed.
Request
This endpoint expects an object.
version
Document version. On update, send back the num from your last read.
domain
The business domain the form belongs to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
title
The title of the form shown to users.
short_description
A short description of the form.
description
An optional longer description of the form. Up to 1000 characters.
fields
The input fields shown on the form.
update_rules
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 updated rich text form, at its new version
id
Unique identifier of this configuration, assigned by the server. Send it in update requests to identify the configuration.
domain
The business domain the form belongs to, such as IT_DOMAIN, HR_DOMAIN or FINANCE_DOMAIN.
form_id
Your unique identifier for the form. Must not duplicate another form's ID and cannot be changed after creation.
title
The title of the form shown to users.
short_description
A short description of the form.
description
An optional longer description of the form. Up to 1000 characters.
fields
The input fields shown on the form.
update_rules
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_time
When the configuration was last updated.
updated_by
Who last updated the configuration.
version
Document version. On update, send back the num from your last read.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error