Updates document folders.
| Scope | documents Deprecated scope name: update_documents_folders |
| App Type | Agency |
| Authorization Type | Access token |
| URI | /v4/settings/documents/folders?lang={lang} |
| HTTP Method | PUT |
| Automation Version(s) | 7.3.3 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| lang | String | No | � | Indicates the language applied. | 7.3.2 |
| description | description{} | No | � | The description of the setting. For example, the document folder description. | 7.3.3 |
| description.text | string | No | � | The localized display text. | 7.3.2 |
| description.value | string | No | � | The value for the specified parameter. | 7.3.2 |
| groupId | string | No | � | The id of the group. | 7.3.3 |
| groupName | string | No | � | The name of the group. | 7.3.3 |
| id | string | No | � | The id of the setting. For example, the document folder id. | 7.3.3 |
| isActive | string | No | Y | N | Indicates whether or not the value is active and available for use. | 7.3.3 |
| order | long | No | � | The display order of the value. | 7.3.3 |
| text | string | No | � | The localized display text. | 7.3.3 |
| value | string | No | � | The value for the specified parameter. | 7.3.3 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | � | 7.3.2 |
| result.code | string | A code identifying an associated item | 7.3.2 |
| result.id | string | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 |
| result.isSuccess | boolean | Indicates whether or not the operation on the item is successful. | 7.3.2 |
| result.message | string | A text message related to the operation. | 7.3.2 |
| status | integer | The record status. | 7.3.3 |