Faqs
Update translation
Saves one language version by hand. The manual text stays until the ORIGINAL
question/answer is edited; then the AI retranslates and replaces it.
PUT
/api/{tenant:minlength(2)}/v{version:apiVersion}/faqs/{id}/translations/{langCode}
- Authorisation
- Minimum role: USER
Request arguments
Request body example
Response
- Status
- 200 (OK)
- Type
- DTO_faq_translation
- Wrapper
- DTO_response_wrap
- Other statuses
- 400 (BadRequest), 401 (Unauthorized), 403 (Forbidden), 429 (TooManyRequests)
Response body example
DTO_faq_translation_update
| Name | Type | ReadOnly | Description |
|---|
| question | String | | Question |
| answer | String | | The answer as plain text; ignored when sys_content_rich is provided |
| sys_content_rich | DTO_rich_text | | Rich (tiptap) answer body - wins over the plain field; the plain variant is
extracted server-side and the rich document is only stored when it actually
carries formatting |
DTO_faq_translation
| Name | Type | ReadOnly | Description |
|---|
| sys_attachments | DTO_reference_attachment[] | ReadOnly | Files (inline images + attachments) referenced by sys_content_rich, with download URLs |
| lang_code | String | | Lang code |
| lang_name | String | ReadOnly | Lang name |
| question | String | | Question |
| answer | String | | Answer |
| sys_content_rich | DTO_rich_text | | Sys content rich |
| up_to_date | Boolean | ReadOnly | Up to date |
| manual | Boolean | ReadOnly | Manual |
DTO_rich_text
| Name | Type | ReadOnly | Description |
|---|
| plain_preview | String | ReadOnly | Plain preview |
| html | String | | Html |
| editorjs | DTO_editorjs | | Editorjs |
| tiptap | DTO_tiptap | | Tiptap |
| read_minutes | Int32 | | Read minutes |
DTO_editorjs
| Name | Type | ReadOnly | Description |
|---|
| time | Int64 | | Time |
| version | String | | Version |
| blocks | DTO_editorjs_block[] | | Blocks |
DTO_editorjs_block
| Name | Type | ReadOnly | Description |
|---|
| id | String | | Id |
| type | String | | Type |
| data | Object | | Data |
DTO_tiptap_attrs
| Name | Type | ReadOnly | Description |
|---|
| textAlign | String | | Textalign |
| level | Int32 (nullable) | | Level |
| checked | Boolean (nullable) | | Checked |
| id | Int32 (nullable) | | Id |
| alt | String | | Alt |
| title | String | | Title |
| width | String | | Width |
| wrapperStyle | String | | Wrapperstyle |
| containerStyle | String | | Containerstyle |
| files | DTO_tiptap_file_ref[] | | Files |
| href | String | | Href |
| target | String | | Target |
| colspan | Int32 (nullable) | | Colspan |
| rowspan | Int32 (nullable) | | Rowspan |
| color | String | | Color |
| text | String | | Text |
| name | String | | For emoji |
| native | String | | For emoji |
DTO_tiptap_file_ref
| Name | Type | ReadOnly | Description |
|---|
| id | Int32 | | Id |
| label | String | | Label |
DTO_reference_attachment
| Name | Type | ReadOnly | Description |
|---|
| size_kb | Int32 | ReadOnly | Size kb |
| status | ENUM attachment_status | ReadOnly | Status |
| status_message | String | ReadOnly | Status message |
| download_url | String | ReadOnly | Download url |
| id | Int32 | | Id |
| label | Object | ReadOnly | Label |
ENUM attachment_status
| Value | Name | Description |
|---|
| 0 | UNKNOWN | UNKNOWN |
| 1 | UNAVAILABLE | UNAVAILABLE, processing in progress |
| 2 | OK | OK |
| 3 | WARNING | WARNING |
| 4 | ERROR | ERROR |
Generated Aug 22, 2026 09:36
