Public Access Links

Deleting a Link

Changed on

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}

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}/public-links/{linkId}
  • Auth
    none declared

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