Update General Settings
Updates the description, name, icon, revision and color theme of an App.
This API updates the pre-live settings.
After using this API, use the
Deploy App Settings API to deploy the settings to the live App.
Method | PUT |
---|---|
URL | https://{subdomain}.kintone.com/k/v1/preview/app/settings.json |
URL(guest space) | https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/preview/app/settings.json |
Authentication | API Token Authentication, Password Authentication |
Content-Type | application/json |
Permissions
- App Management Permissions are needed.
Request Parameters
Parameters that are ignored will not be updated.
Parameter | Value | Required | Description |
---|---|---|---|
app | String | Yes | The App ID. |
name | String | The App name. The maximum character limit is 64. | |
description | String | The App description. The maximum character limit is 10,000. HTML tags can be used. | |
icon | Object | An object containing information of the App icon. | |
icon.type | String | Conditional | The icon type. Specify one of the following:
|
icon.key | String | Conditional | The key identifier of the icon. Required, if the "icon.type" parameter is set as "PRESET". (Preset icons have key identifiers that can be obtained using the Get General Settings API.) |
icon.file | Object | Conditional | An object containing information of uploaded icon files. Required, if the "icon.type" parameter is set as "FILE". |
icon.file.fileKey | String | Conditional | The fileKey of the icon. To attach a file, specify the fileKey responded when using the Upload File API. The maximum file size limit is 800KB. Required, if the "icon.type" parameter is set as "FILE". |
theme | String | The Color theme. The following can be specified:
|
|
revision | Integer or String | Specify the revision number of the settings that will be deployed. The request will fail if the revision number is not the latest revision. The revision will not be checked if this parameter is ignored, or -1 is specified. |
Sample Request
JavaScript (using Kintone REST API Request)
|
|
XMLHttpRequest
|
|
Response Parameters
Parameter | Type | Description |
---|---|---|
revision | String | The revision number of the App settings. |
Sample Response
|
|