Survey data

Bulk delete submissions

  curl -X DELETE https://kf.kobotoolbox.org/api/v2/assets/aSAvYreNzVEkrWg5Gdcvg/data/bulk/

Payload

{
           "submissions_ids": [
               1,
               2
           ]
        }
  • Where: submissions_ids (required) is a list of submission root id on the data to delete

Response

{
           "detail": "{number_of_submissions} submissions have been deleted"
}
  • Where: number_of_submissions is the number of items that was deleted

Due to limitations with DRF-Spectacular current version, DELETE actions do not support showing a request body OR a response body. This is due to the 'vague' nature of the action which generally does not recommend the use of a payload. To still document this endpoint, example for the payload and response will be included but it will not be possible to test this endpoint. The HTTP code and the errors example are, for their part, factual and can be considered when working with the endpoint.

delete/api/v2/assets/{uid_asset}/data/bulk/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idinteger required

ID of the data (when applicable)

uid_assetstring required

UID of the parent asset

Response

No response body

Changes

No recorded changes to this operation across all 50 revisions of this API.