Skip to main content
Kintone REST logo
  • Category: app builder
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 55
  • Triggers: 0
  • Slug: KINTONE_REST
  • Version: 20261030_00

Tools

Slug: KINTONE_REST_ADD_COMMENTAdd one comment to a Kintone record, optionally mentioning up to 10 users, groups, or organizations. The app’s commenting feature must be enabled.

Input Parameters

string
required
Comment text, from 1 to 65,535 characters.
integer
required
App ID containing the record.
array
Users, groups, or organizations to mention, up to 10.
integer
required
Record ID to comment on.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_ADD_FORM_FIELDSAdd typed fields to an app’s pre-live form, including selections, lookups, related-record lists, groups, and nested tables. Deploy app settings separately to make them live.

Input Parameters

integer
required
App ID whose pre-live form should receive the fields.
integer
Expected settings revision. Omit or use -1 to skip the revision check.
object
required
Fields keyed by field code. Each value is selected by its type, including nested table fields.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_ADD_PREVIEW_APPCreate a pre-live Kintone app and return its app ID and initial settings revision. Kintone provides no REST API to delete the created preview app, so this creation cannot be undone through the API. Deploy it separately when its settings are ready.

Input Parameters

string
required
Name of the preview app, up to 64 characters.
integer
Space ID in which to create the app.
integer
Thread ID in the space. Omit to use the default thread, as Kintone recommends.
integer
Guest Space ID for the guest-space route; omit for the regular route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_CREATE_RECORDCreate one record in a Kintone app from field-code values and return its record ID and revision.

Input Parameters

integer
required
App ID in which to create the record.
object
Record fields keyed by app field code. Each field must use Kintone’s {value: …} write format. Omit to create the record with Kintone field defaults; an empty object explicitly supplies no field values. Use Get App Form Fields first when needed.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_CREATE_RECORDSCreate one to 100 records atomically in one Kintone app and return their record IDs and revisions in input order.

Input Parameters

integer
required
App ID in which to create all records.
array
required
One to 100 records to create in order. Each object is keyed by app field code, and each field uses Kintone’s {value: …} write format. The entire batch is canceled if any record fails.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_DELETE_COMMENTPermanently delete one comment from a Kintone record. With OAuth user authentication, only a comment created by that user can be deleted.

Input Parameters

integer
required
App ID containing the record.
integer
required
Record ID containing the comment.
integer
required
Comment ID to permanently delete.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_DELETE_FORM_FIELDSDelete up to 100 fields from an app’s pre-live form. Deleting a group or table also deletes every field it contains. The deletion affects preview settings until deployed and returns the resulting revision.

Input Parameters

integer
required
App ID containing the fields.
array
required
Field codes to delete, from 1 to 100 codes. Deleting a group or table also deletes its contained fields.
integer
Expected settings revision. Omit or use -1 to skip the revision check.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_DELETE_RECORDSPermanently delete one to 100 explicitly identified records from a Kintone app. If revisions are supplied, Kintone deletes no records when any revision does not match.

Input Parameters

integer
required
App ID containing the records.
array
Expected revisions paired positionally with record_ids. Omit to skip checks; use -1 to skip one check.
array
required
One to 100 record IDs to permanently delete.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_DEPLOY_APP_SETTINGSAtomically apply the complete pre-live settings of up to 300 Kintone apps to their live apps. If one deployment fails, Kintone rolls every app in the request back to its pre-request state.

Input Parameters

array
required
Apps to deploy atomically, from 1 to 300 entries.
integer
Guest Space ID when every app belongs to that guest space; omit for regular apps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_DISCARD_APP_SETTINGS_CHANGESPermanently discard every pre-live settings change for up to 300 Kintone apps and restore each preview to its current live settings. This does not change the live apps. If one discard fails, Kintone rolls back the entire request.

Input Parameters

array
required
Apps whose entire pre-live settings changes should be discarded, from 1 to 300 entries.
integer
Guest Space ID when every app belongs to that guest space; omit for regular apps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_DOWNLOAD_FILEDownload an attachment up to 100 MB using the file key returned by a record read. Files larger than 100 MB are rejected.

Input Parameters

string
required
Attachment file key returned by Get Record or Search Records.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_ACTION_SETTINGSReturn deployed or unpublished record-copy action settings of an app, including destinations, mappings, availability, order, and revision.

Input Parameters

integer
required
App ID whose settings should be returned.
string ("default" | "en" | "zh" | "ja" | "user")
Language for localized names. Use user for the connected user’s language.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed for live settings or preview for unpublished changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_APPGets general information of an App, including the name, description, related Space, creator and updater information. Use guest_space_id only when the target app belongs to a Kintone guest space.

Input Parameters

integer
required
App ID whose general information should be returned.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_APP_DEPLOY_STATUSGet the deployment status of settings for up to 300 Kintone apps.

Input Parameters

array
required
App IDs whose deployment status should be checked, from 1 to 300 IDs.
integer
Guest Space ID when every requested app belongs to that guest space; omit for regular apps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_APP_PERMISSIONSReturn deployed or unpublished app-level permissions and settings revision in priority order.

Input Parameters

integer
required
App ID whose app permissions should be returned.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Permissions state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_APP_SETTINGSReturn an app’s deployed or unpublished name, description, title-field configuration, feature flags, theme, icon, and revision.

Input Parameters

integer
required
App ID whose deployed settings should be returned.
string ("default" | "en" | "zh" | "ja" | "user")
Language for localized app settings; user uses the connected user’s language.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed for live settings or preview for unpublished changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_CUSTOMIZATIONReturn deployed or unpublished desktop and mobile JavaScript and CSS customization files, scope, and revision for an app.

Input Parameters

integer
required
App ID whose settings should be returned.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed for live settings or preview for unpublished changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_FIELD_PERMISSIONSReturn deployed or unpublished field permissions, including prioritized subjects and each field’s access level.

Input Parameters

integer
required
App ID whose field permissions should be returned.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Permissions state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_FORMRead a deployed or unpublished app form in Kintone’s legacy property-array format. This reader omits Categories, Status, and Field Groups; inside Field Groups, it also omits system-generated fields, blank spaces, labels, and borders. Use GET_FORM_FIELDS for field definitions and settings keyed by field code, or GET_FORM_LAYOUT for row, group, table, and field-size layout data.

Input Parameters

integer
required
App ID whose form details should be returned.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Form state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_FORM_FIELDSReturn deployed or unpublished field codes, types, labels, and settings so an agent can construct valid record values and queries.

Input Parameters

integer
required
App ID whose form fields should be returned.
string ("default" | "en" | "zh" | "ja" | "user")
Language for localized field and option names. Use user for the connected user’s language.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Form state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_FORM_LAYOUTReturn deployed or unpublished field layout information for an app form, including rows, groups, tables, fields, and sizes.

Input Parameters

integer
required
App ID whose form layout should be returned.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Form state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_GENERAL_NOTIFICATION_SETTINGSGet an app’s deployed or unpublished general-notification recipients, event conditions, commenter option, and revision.

Input Parameters

integer
required
App ID whose notification settings to get.
integer
Guest Space ID; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_GRAPH_SETTINGSReturn deployed or unpublished graph definitions with their chart, aggregation, grouping, sorting, periodic-report settings, and revision.

Input Parameters

integer
required
App ID whose settings should be returned.
string ("default" | "en" | "zh" | "ja" | "user")
Language for localized names. Use user for the connected user’s language.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed for live settings or preview for unpublished changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_PER_RECORD_NOTIFICATION_SETTINGSGet an app’s deployed or unpublished conditional per-record notifications, recipients, subjects, and revision.

Input Parameters

integer
required
App ID whose notification settings to get.
string ("default" | "en" | "zh" | "ja" | "user")
Language used for localized option names in filter conditions.
integer
Guest Space ID; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_PROCESS_MANAGEMENT_SETTINGSReturn deployed or unpublished process-management enablement, statuses, assignee rules, transitions, branch conditions, and revision.

Input Parameters

integer
required
App ID whose settings should be returned.
string ("default" | "en" | "zh" | "ja" | "user")
Language for localized names. Use user for the connected user’s language.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed for live settings or preview for unpublished changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_RECORDRetrieve one record from a Kintone app by its record ID.

Input Parameters

integer
required
App ID containing the record.
integer
required
Kintone record ID to retrieve.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_RECORD_PERMISSIONSReturn deployed or unpublished record permission rules, preserving each query filter and prioritized subject list.

Input Parameters

integer
required
App ID whose record permissions should be returned.
string ("default" | "en" | "zh" | "ja" | "user")
Language used for localized option names in permission filter conditions.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Permissions state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_REMINDER_NOTIFICATION_SETTINGSGet an app’s deployed or unpublished reminder timing, filters, recipients, timezone, and revision.

Input Parameters

integer
required
App ID whose notification settings to get.
string ("default" | "en" | "zh" | "ja" | "user")
Language used for localized option names in filter conditions.
integer
Guest Space ID; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed or preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_GET_VIEWSReturn deployed or unpublished list, calendar, custom, and built-in view settings, including filters, sorting, displayed fields, and revision.

Input Parameters

integer
required
App ID whose settings should be returned.
string ("default" | "en" | "zh" | "ja" | "user")
Language for localized names. Use user for the connected user’s language.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.
string ("deployed" | "preview")
required
Settings state to read: deployed for live settings or preview for unpublished changes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_LIST_APPSFind apps visible to the connected Kintone user by name, ID, code, or space and return one offset-controlled page of app metadata.

Input Parameters

string
Partial app-name search; matching is case-insensitive and includes the connected user’s localized app name.
integer
Maximum apps to return in this page, from 1 to 100.
integer
Number of matching apps to skip; pass the prior next_offset to continue.
array
Exact app IDs to return, up to 100.
array
Exact case-sensitive app codes to return, up to 100; each code must be 1-64 characters.
array
Return apps belonging to any of these space IDs, up to 100 IDs.
integer
Guest Space ID when listing apps through the guest-space API route; omit for regular apps.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_LIST_COMMENTSRetrieve one offset-controlled page of up to 10 comments from a Kintone record. The app’s commenting feature must be enabled.

Input Parameters

integer
Maximum comments to return in this page, from 1 to 10.
string ("ASC" | "DESC")
Comment ID sort order.
integer
required
App ID containing the record.
integer
Number of comments to skip; pass the prior next_offset to continue.
integer
required
Record ID whose comments to retrieve.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_SEARCH_RECORDSSearch an app’s records with a Kintone query and return one offset-controlled page. OAuth searches cannot continue beyond offset 10,000.

Input Parameters

integer
Maximum records in this page, from 1 to 500.
string
Kintone filter and order expression. Do not include limit or offset clauses; this tool appends them.
integer
required
App ID whose records should be searched.
array
Field codes to include; omit to return all accessible app fields.
integer
Records to skip, from 0 to 10,000; pass prior next_offset to continue.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.
boolean
Whether to ask Kintone for the total matching record count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_ACTION_SETTINGSReplace the complete unpublished record-copy action map. Existing preview actions omitted from actions are deleted, so read preview action settings first and include every action to retain. Deploy app settings separately to make the replacement live.

Input Parameters

integer
required
App ID whose preview action settings should be updated.
object
required
Complete desired preview action map keyed by default-language name. Existing actions omitted from this map are deleted. Read preview action settings first and include every action that must be retained.
integer
Expected current settings revision. Omit or use -1 to skip revision checking.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_APP_PERMISSIONSReplace app-level permissions in priority order and deploy all pending app settings, not only permissions. This can immediately revoke app or record access for omitted or restricted entities; read the current and preview settings first when preserving access.

Input Parameters

integer
required
App ID whose deployed app permissions should be replaced.
array
required
Complete app permission list in priority order.
integer
Expected latest settings revision; omit or use -1 to skip the check.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_ASSIGNEESReplace the assignees of one Kintone record whose app uses Process Management. An empty assignee list removes all assignees; the caller needs app-management and record-view permissions.

Input Parameters

integer
required
App ID containing the record.
integer
Expected current record revision. Omit or use -1 to skip the revision check.
array
required
User codes to assign, up to 100. Pass an empty list to remove all assignees.
integer
required
Record ID whose assignees to replace.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_CUSTOMIZATIONUpdate unpublished desktop and mobile JavaScript and CSS customization. Deploy app settings separately to make changes live.

Input Parameters

string ("ALL" | "ADMIN" | "NONE")
Users affected by the customization.
integer
required
App ID whose preview customization should be updated.
object
Mobile JavaScript and CSS settings.
object
Desktop JavaScript and CSS settings.
integer
Expected current settings revision. Omit or use -1 to skip revision checking.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_FIELD_PERMISSIONSReplace field permissions and deploy all pending app settings, not only permissions. This can immediately revoke field access for omitted fields or entities and settings are applied to affected fields sequentially; read the current and preview settings first when preserving access.

Input Parameters

integer
required
App ID whose deployed field permissions should be replaced.
array
required
Complete field permission list in priority order.
integer
Expected latest settings revision; omit or use -1 to skip the check.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_FORM_FIELDSUpdate typed field settings in an app’s pre-live form. Supplying options replaces that field’s complete option set and deletes omitted options. Deploy app settings separately to make changes live.

Input Parameters

integer
required
App ID whose pre-live field settings should change.
integer
Expected settings revision. Omit or use -1 to skip the revision check.
object
required
Partial field updates keyed by current field code. Select each value by type; use code inside a value to rename that field.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_FORM_LAYOUTReplace an app’s complete pre-live form layout. Kintone requires every form field to be included in the request. Deploy app settings separately to make the layout live.

Input Parameters

integer
required
App ID whose pre-live form layout should change.
array
required
Complete form layout. Include every field in typed ROW, SUBTABLE, or recursive GROUP entries; omitted fields are removed from the layout.
integer
Expected settings revision. Omit or use -1 to skip the revision check.
integer
Guest Space ID when the app belongs to a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_GENERAL_NOTIFICATION_SETTINGSReplace or selectively update an app’s undeployed general-notification settings; deploy the app settings afterward to make them live.

Input Parameters

integer
required
App ID whose preview settings to update.
integer
Latest settings revision for optimistic concurrency; omit or use -1 to skip the check.
array
Complete replacement recipients and event conditions; an empty list removes all recipients. Set this or notify_to_commenter.
integer
Guest Space ID; omit for a regular app.
boolean
Whether all commenters are notified. Set this or notifications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_GENERAL_SETTINGSUpdate unpublished general app settings such as name, description, icon, theme, feature flags, title field, and number precision. Deploy separately.

Input Parameters

object
Preset or uploaded app icon.
string
New app name.
string ("WHITE" | "RED" | "BLUE" | "GREEN" | "YELLOW" | "BLACK")
App color theme.
integer
required
App ID whose preview general settings should be updated.
integer
Expected current settings revision. Omit or use -1 to skip revision checking.
string
New HTML app description.
object
Record title-field settings.
integer
Guest Space ID; omit for a regular app.
boolean
Whether record comments are enabled.
object
Number precision settings.
boolean
Whether thumbnails are shown.
boolean
Whether users can bulk-delete records.
boolean
Whether users can duplicate records.
integer
First fiscal-year month, from 1 to 12.
boolean
Whether inline record editing is enabled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_GRAPH_SETTINGSReplace the complete unpublished graph map. Existing preview graphs omitted from reports are deleted, so read preview graph settings first and include every graph to retain. Deploy app settings separately to make the replacement live.

Input Parameters

integer
required
App ID whose preview graph settings should be updated.
object
required
Complete desired preview graph map keyed by default-language name. Existing graphs omitted from this map are deleted. Read preview graph settings first and include every graph that must be retained.
integer
Expected current settings revision. Omit or use -1 to skip revision checking.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_PER_RECORD_NOTIFICATION_SETTINGSReplace an app’s undeployed per-record notification rules; deploy the app settings afterward to make them live.

Input Parameters

integer
required
App ID whose preview settings to update.
integer
Latest settings revision for optimistic concurrency; omit or use -1 to skip the check.
array
required
Complete per-record notification settings; an empty list deletes all settings.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_PREVIEW_APP_PERMISSIONSReplace the complete unpublished app-level permission list in priority order without deploying it. Omitted or restricted entities may lose access when the preview settings are later deployed; read preview permissions first when preserving access.

Input Parameters

integer
required
App ID whose preview app permissions should be replaced.
array
required
Complete app permission list in priority order.
integer
Expected latest settings revision; omit or use -1 to skip the check.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_PREVIEW_FIELD_PERMISSIONSReplace the complete unpublished field permission list without deploying it. Omitted fields or entities may lose access when the preview settings are later deployed; read preview field permissions first when preserving access.

Input Parameters

integer
required
App ID whose preview field permissions should be replaced.
array
required
Complete field permission list in priority order.
integer
Expected latest settings revision; omit or use -1 to skip the check.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_PREVIEW_RECORD_PERMISSIONSReplace the complete unpublished record permission rule list without deploying it. Omitted or restricted rules may revoke record access when the preview settings are later deployed; read preview record permissions first when preserving access.

Input Parameters

integer
required
App ID whose preview record permissions should be replaced.
array
required
Complete record permission list in priority order, including each filter condition.
integer
Expected latest settings revision; omit or use -1 to skip the check.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_PROCESS_MANAGEMENT_SETTINGSUpdate unpublished process-management settings. When states is supplied it is the complete desired preview status map: omitted statuses are deleted, so read preview process settings first and include every status to retain. Deploy app settings separately.

Input Parameters

integer
required
App ID whose preview process settings should be updated.
boolean
Whether process management should be enabled.
object
Complete desired preview status map keyed by status name. Existing statuses omitted from this map are deleted; the first status cannot be deleted. Read preview process settings first and include every status that must be retained.
array
Complete process transition list in display order. Each transition requires name, from, and to; filterCond is optional.
integer
Expected current settings revision. Omit or use -1 to skip revision checking.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_RECORDUpdate selected fields of one Kintone record by record ID, optionally requiring an expected revision.

Input Parameters

integer
required
App ID containing the record.
object
required
Fields to change, keyed by app field code, with each value in Kintone’s {value: …} write format. Omitted fields are unchanged.
string
Expected current revision for optimistic concurrency. Omit or use -1 to skip the revision check.
integer
required
Kintone record ID to update. This tool does not update by unique key.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_RECORD_PERMISSIONSReplace record permission rules and deploy all pending app settings, not only permissions. This can immediately revoke record access for omitted or restricted rules and settings are applied to affected records sequentially; read the current and preview settings first when preserving access.

Input Parameters

integer
required
App ID whose deployed record permissions should be replaced.
array
required
Complete record permission list in priority order, including each filter condition.
integer
Expected latest settings revision; omit or use -1 to skip the check.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_RECORDSUpdate selected fields of one to 100 Kintone records atomically by record ID, optionally checking each revision. This tool does not select by unique key and never upserts.

Input Parameters

integer
required
App ID containing all records to update.
array
required
One to 100 record updates applied atomically. Every update selects a record by ID; this tool never upserts.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_REMINDER_NOTIFICATION_SETTINGSReplace or selectively update an app’s undeployed reminder rules and timezone; deploy the app settings afterward to make them live.

Input Parameters

integer
required
App ID whose preview settings to update.
integer
Latest settings revision for optimistic concurrency; omit or use -1 to skip the check.
string
IANA timezone used to calculate reminder times. Set this or notifications.
array
Complete reminder rules; an empty list removes all rules. Set this or timezone.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_STATUSRun one Process Management action to update a Kintone record’s workflow status, optionally selecting the next assignee and checking the current revision.

Input Parameters

string
required
Process Management action name in the authenticated user’s language.
integer
required
App ID containing the record.
string
Next assignee’s user code. Required by Kintone when the workflow action requires choosing an assignee.
integer
Expected current record revision. Omit or use -1 to skip the revision check.
integer
required
Record ID whose workflow status to update.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_STATUSESRun Process Management actions for one to 100 Kintone records in the same app, optionally selecting assignees and checking revisions.

Input Parameters

integer
required
App ID containing all records to update.
array
required
One to 100 workflow status updates, each selecting a record by ID.
integer
Guest Space ID when the app is in a guest space; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPDATE_VIEWSReplace the complete unpublished list, calendar, and custom view map. Existing preview views omitted from views are deleted, so read preview views first and include every view to retain. Deploy app settings separately to make the replacement live.

Input Parameters

object
required
Complete desired preview view map keyed by default-language name. Existing views omitted from this map are deleted. Read preview views first and include every view that must be retained.
integer
required
App ID whose preview views should be updated.
integer
Expected current settings revision. Omit or use -1 to skip revision checking.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: KINTONE_REST_UPLOAD_FILEUpload one managed file to Kintone and return the temporary file key used to attach it to a record within three days.

Input Parameters

object
required
Single managed file to upload to Kintone.
integer
Guest Space ID; omit for a regular app.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not