Deleting a Public Interview Link
The Delete public interview link API method enables you to permanently delete a public interview link.
Prerequisites
Before making a 'delete public interview link' request, you must have an access token to sign the request. You can retrieve an access token using one of the following flows:
- Getting an access token using the Resource Owner flow
- Getting an access token using the Implicit flow
Overview
The 'delete public interview link' API method is a command method. The API client invoking this method must have either a command or a root scope.
This method is useful when you want to delete a public interview link.
Ensure you also remove the link from your website. Customers clicking a deleted link will receive a 404 response.
Authentication
See Authentication for more information about authenticating requests to the Advance API.
API Documentation
You can view the latest reference documentation for the Advance API at https://yourorganization.com/HdaApi/rest/documentation/index.html, where yourorganization.com is the domain under which your Advance deployment is located.
Request
Request URL
DELETE https://{tenancymoniker}.{domain}/HdaApi/rest/v1.1/PublicInterviewLinks/{publicInterviewLinkId}
Headers
| Key | Required | Description | Example value |
| Authorization | Yes | The Authorization header for the request. Uses the access token retrieved (see Prerequisites section above for more information). | Bearer [access token] |
Parameters
| Name | Type | Location | Required | Description |
| tenancymoniker | String | URL | Yes | The tenancy moniker for the tenancy in which you want to create the new work item. |
| domain | String | URL | Yes | Your domain. For example, yourorganization.com. |
| publicInterviewLinkId | Guid | URL | Yes | The ID that identifies the public interview link. The ID cannot be the same as that of an existing public interview link. |
Example Response
Status: 204 The public interview link has been deleted or does not exist