Update Record (Single)

kintone offers a rich set of APIs that allow you to directly manipulate application data programmatically.

In particular, the REST API is a powerful tool for manipulating kintone data through HTTP requests.

This page provides a detailed explanation of how to update a specific record using the kintone REST API.

If you need to update multiple records, the endpoint is different. Please refer to the following page for details.

Using from kintone

When executing the REST API as a JavaScript customization in kintone, you can easily execute the REST API using the provided JavaScript API.

By using the kintone.api.url method of the JavaScript API, you can obtain the REST API endpoint without worrying about the execution space.

/**
 * Update a record in the app using the kintone REST API
 *
 * @param { { app: string | number; revision?: string | number; record?: Record<string, any>; } & ({ id: string | number } | { updateKey: { field: string; value: string } }) } params
 * @return { Promise<{ revision: string }> } - The revision number of the updated record
 */
const updateRecord = (params) => {
  return kintone.api(kintone.api.url('/k/v1/record.json', true), 'PUT', params);
};

When updating multiple records, specify records.json, but when updating a single record, specify record.json.

For the arguments, specify the app ID to add to, the information to specify the target for the update, and the record information to update.

You can specify the target by specifying the id property to specify the record ID.

Alternatively, you can specify the target by specifying the field code set to unique and its value in the updateKey property.

If the update is successful, an object with the revision property is returned.

(() => {
  const updateRecord = (params) => {
    /** omitted */
  };

  kintone.events.on(['app.record.detail.show'], async (event) => {
    const recordId = kintone.app.record.getId();
    await updateRecord({
      app: kintone.app.getId(),
      id: recordId,
      record: {
        fieldCode: { value: 'Updated value' },
      },
    });
    return event;
  });
})();

(() => {
  const updateRecord = (params) => {
    /** omitted */
  };

  kintone.events.on(['app.record.index.show'], async (event) => {
    const recordId = prompt('Please enter the ID of the record to update');
    await updateRecord({
      app: kintone.app.getId(),
      id: recordId,
      record: {
        fieldCode: { value: 'Updated value' },
      },
    });
    return event;
  });
})();

Using from outside kintone

The kintone REST API can be used from various environments such as Excel, GAS, and Node.js.

By using the REST API, you can operate applications using kintone data from environments other than kintone.

Using Node.js

When using the kintone REST API from Node.js, you can send HTTP requests with almost the same code as executing JavaScript in the browser.

/**
 * Update a record in the app using the kintone REST API
 *
 * @param { { app: string | number; revision?: string | number; record?: Record<string, any>; } & ({ id: string | number } | { updateKey: { field: string; value: string } }) } params
 * @return { Promise<{ revision: string }> } - The revision number of the updated record
 */
const updateRecord = (params) => {
  const url = `https://__your_subdomain__.cybozu.com/k/v1/record.json`;
  const options = {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      'X-Cybozu-API-Token': 'YOUR_API_TOKEN',
    },
    body: JSON.stringify(params),
  };
  return fetch(url, options).then((response) => response.json());
};

Replace __your_subdomain__ and YOUR_API_TOKEN with your own environment settings.

You can set these as arguments, but it is also fine to set them directly within the function.

Unlike the code used from kintone mentioned earlier, if the referenced app is in a guest space, you need to change the URL.

Using GAS

When using the kintone REST API from Google Apps Script (GAS), you can send HTTP requests using the UrlFetchApp class.

/**
 * Update a record in the app using the kintone REST API
 *
 * @param { { app: string | number; revision?: string | number; record?: Record<string, any>; } & ({ id: string | number } | { updateKey: { field: string; value: string } }) } params
 * @return { Promise<{ revision: string }> } - The revision number of the updated record
 */
const updateRecord = (params) => {
  const url = `https://__your_subdomain__.cybozu.com/k/v1/record.json`;
  const options = {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      'X-Cybozu-API-Token': 'YOUR_API_TOKEN',
    },
    payload: JSON.stringify(params),
  };
  const response = UrlFetchApp.fetch(url, options);
  return JSON.parse(response.getContentText());
};