Delete Records (DELETE)

Delete RecordsDELETE /records.json

Deletes multiple records in an app.
URI
https://{subdomain}.kintone.com/k/v1/records.json
URI for Guest Space Apps
https://{subdomain}.kintone.com/k/guest/{SpaceID}/v1/records.json

Request Parameters

PARAMETER VALUE REQUIRED DESCRIPTION
app Integer Yes The app ID.
ids Array of Integers Yes Array of record IDs that will be deleted.
revisions Array of Integers Optional The Expected revision number.

The first id number will correspond to the first revision number in the array, the second id to the second revision number, and so on.
If the revision number does not match, an error will occur and no records will be deleted.
If the revision number is left blank or is -1, the revision number will not be checked for the corresponding record ID.

Sample Request using Query Strings

The "app", "ids" and "revisions" are joined with an "&", and sent as an HTTP query string.
"ids" and revisions are written as incremental arrays from 0 to 99.

Query String

app=8&ids[0]=100&ids[1]=80&revisions[0]=1&revisions[1]=4

Request Header

DELETE /k/v1/records.json? app=8&ids[0]=100&ids[1]=80&revisions[0]=1&revisions[1]=4 HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=

Sample Request using JSON

Request Header

DELETE /k/v1/records.json HTTP/1.1
Host: example.kintone.com:443
X-Cybozu-Authorization: a2ludG9uZTpkZXZlbG9wZXI=
Content-Type: application/json

Body

{
    "app": 1,
    "ids": [
        100,
        80
    ],
    "revisions": [
        1,
        4
    ]
}

Response

An empty JSON is returned if succeeded.

{}

Limitations

  • You must have permission to delete records inside the app.
  • The maximum number of records that can be deleted is 100.
  • If the process fails, no records will be deleted.
Was this article helpful?
0 out of 0 found this helpful
Comments
Please sign in to leave a comment.