Public Access Links

Deleting a Link

You can fully delete a link by issuing DELETE to its resource. This will remove the Link from the system entirely. If instead you wish to revoke the Link's access to prevent future submission without removing its record entirely, you can issue DELETE /sessions/:token.

delete/v1/projects/{projectId}/forms/{xmlFormId}/public-links/{linkId}

Path parameters

projectIdnumber required

The numeric ID of the Project

xmlFormIdstring required

The xmlFormId of the Form being referenced.

linkIdinteger required

The numeric ID of the Link

Response

OK

successboolean required

Example response

{
  "success": true
}

Changes

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

    • api operation id Deleting a Link removed and replaced with deleteLink

      api-operation-id-removed

    • removed the non-success response with the status 403

      response-non-success-status-removed

    • api operation id deleteLink removed and replaced with Deleting a Link

      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