Individual Form

Deleting a Form

Changed on

When a Form is deleted, it goes into the Trash section, but it can now be restored from the Trash. After 30 days in the Trash, the Form and all of its resources and submissions will be automatically purged. If your goal is to prevent it from showing up on survey clients like ODK Collect, consider setting its state to closing or closed instead (see Modifying a Form just above for more details).

The API usually identifies forms by their projectId and xmlFormId, but if a Form is deleted, the same xmlFormId can be reused. To restore a deleted Form, use its numeric ID, which can be retrieved by listing Forms with ?deleted=true.

delete/v1/projects/{projectId}/forms/{xmlFormId}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{projectId}/forms/{xmlFormId}
  • Auth
    none declared

Path parameters

xmlFormIdstring required

The xmlFormId of the Form being referenced.

projectIdnumber required

The numeric ID of the Project

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes