Delete a Redirect
helpcenter_delete_redirectDelete a redirect: its path goes back to the help center's not-found page.
Works once the user has claimed the help center, verified their email address and activated a plan; until then it answers capability_locked with the user's next step (helpcenter_get_help_center shows it too).
Args:
redirect_id (number, required): from helpcenter_list_redirects.
Returns: { redirect: { id, deleted: true } }.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| agent_key | Yes | The api_key helpcenter_create_help_center returned for this help center, exactly as returned. Required on every call: this endpoint has no sign-in, so the key is how each call says which help center it acts on. It is sent to HelpCenter.io as this call's credential and nowhere else, and it is never shown again: keep it for the whole task, and never show it to the user or write it into content. | |
| redirect_id | Yes | The redirect's id, from helpcenter_list_redirects. |