Intercom API (unofficial showcase)
DELETE/help_center/help_centers/{help_center_id}/redirects/{id}

Delete a help center redirect

Deletes a redirect from a help center. Provide the help center and redirect identifiers to specify which redirect to remove. Access requires the read_write_help_center_redirects_scope OAuth scope.

3 parameters
help_center_idstringrequired
The unique identifier of the help center containing the redirect.
idstringrequired
The unique identifier of the redirect to delete.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; listed supported values include 1.0 through 1.4 and 2.0 through 2.6.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the deleted redirect's identifier, object type, and a boolean indicating whether deletion succeeded.
idstringoptional
The unique identifier for the redirect which you provided in the URL.
objectstringoptional
The type of object which was deleted. - `help_center_redirect`
Allowed:help_center_redirect
deletedbooleanoptional
Whether the redirect was deleted successfully or not.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the help center or redirect is not found.

One documented failure

  • not_found

    Resource not found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized, and a 404 is returned when the help center or redirect is not found. The help_center_id path parameter must identify the help center, and the id path parameter must identify a redirect in that help center. Access requires the read_write_help_center_redirects_scope OAuth scope.