Update Folders

Updates document folders.

Resource Information

Scopedocuments

Deprecated scope name:   update_documents_folders

App TypeAgency
Authorization TypeAccess token
URI /v4/settings/documents/folders?lang={lang}
HTTP MethodPUT
Automation Version(s)7.3.3

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
langStringNo Indicates the language applied.7.3.2
descriptiondescription{}No The description of the setting. For example, the document folder description.7.3.3
description.textstringNo The localized display text.7.3.2
description.valuestringNo The value for the specified parameter.7.3.2
groupIdstringNo The id of the group.7.3.3
groupNamestringNo The name of the group.7.3.3
idstringNo The id of the setting. For example, the document folder id.7.3.3
isActivestringNoY | NIndicates whether or not the value is active and available for use.7.3.3
orderlongNo The display order of the value.7.3.3
textstringNo The localized display text.7.3.3
valuestringNo The value for the specified parameter.7.3.3

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.codestringA code identifying an associated item7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.isSuccessbooleanIndicates whether or not the operation on the item is successful. 7.3.2
result.messagestringA text message related to the operation.7.3.2
statusintegerThe record status.7.3.3