Sign in
Individual Form

Deleting a Form

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}

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

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Deleting a Form removed and replaced with deleteForm

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id deleteForm removed and replaced with Deleting a Form

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog