Redirect Rules

Note: The Redirect Rules API is in early access. Learn more and join the Redirect Rules early access program.

The Redirect Rules API lets you create and manage page redirects for objects or URLs that return an HTTP 404 response. For example, this means that to redirect an article URL, the article must be archived or deleted. Similarly for sections, categories, community posts, etc. the object must be deleted for the redirect to take effect. The API has the following three primary use cases, each with their own URL patterns.

• Redirecting deleted objects: If a help center article or section is deleted, you can redirect the old URL to a new article or section to prevent 404 errors and for SEO purposes. Examples:
  • /hc/en-us/articles/12345678
  • /hc/en-us/community/topics/200550545
  • /hc/en-us/sections/45678912
• Redirecting previous URLs when migrating to Zendesk: If you're migrating content from a non-Zendesk product or service and you're keeping the same subdomain, you can redirect the old URLs to the corresponding Zendesk URLs to maintain SEO for your uses and crawlers. Examples:
  • /2023/01/01/blog-post-title
  • /en/support/home
  • /en/support/solutions/articles/1234
• Redirecting vanity URLs or other patterns: There may be other reasons to set up vanity URLs or other patterns under your Zendesk subdomain or host-mapped subdomain. For example, you can create short URLs that redirect to articles or custom pages. You can set up a redirect for any non-reserved URL pattern for an active brand or host-mapped subdomain. Examples:
  • /contact-us
  • /offers
  • /videos

JSON format

Redirect Rules are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
brand_id	string	false	false	ID of the brand to which this redirect rule applies
created_at	string	true	false	When the redirect rule was created
id	string	true	true	Automatically assigned when the redirect rule is created
redirect_from	string	false	true	The path to redirect from. Must begin with '/'. Omit any slug from the path
redirect_status	string	false	true	The HTTP status to use when redirecting. See Redirections in HTTP in the MDN docs. Allowed values are "301", or "302".
redirect_to	string	false	true	The URL or path to redirect to. Must begin with 'https://', 'http://', or '/'
updated_at	string	true	false	When the redirect rule was last updated

Example

{
  "brand_id": "12345",
  "created_at": "2022-10-13T12:00:00.000Z",
  "id": "01GFXGBX7YZ9ASWTCVMASTK8ZS",
  "redirect_from": "/hc/en-us/articles/7654321",
  "redirect_status": "301",
  "redirect_to": "https://help.example.com/account/setting-up-your-account",
  "updated_at": "2022-10-13T12:00:00.000Z"
}

Search Redirect Rules

• GET /api/v2/guide/redirect_rules

Lists redirect rules matching the given criteria.

Allowed for

• Guide admins

Pagination

• Cursor pagination only

See Using cursor based pagination.

Parameters

Name	Type	In	Required	Description
filter[redirect_from_prefix]	object	Query	false	Limit the search to redirect rules where redirect_from has this prefix
page	object	Query	false	A group of query parameters used for pagination. See Pagination
sort	string	Query	false	Options for sorting the result set by field and direction. The "-" prefix indicates DESC order. No prefix indicates ASC order order. Allowed values are "id", "-id", "redirect_from", or "-redirect_from".

Code Samples

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/redirect_rules \
  --get \
  --data-urlencode "filter[redirect_from_prefix]=/hc/en-us" \
  --data-urlencode "sort=redirect_from" \
  -v -u {email_address}:{password}

Go

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules?filter[redirect_from_prefix]=&page=&sort="
	method := "GET"
	req, err := http.NewRequest(method, url, nil)

	if err != nil {
		fmt.Println(err)
		return
	}
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Basic <auth-value>") // Base64 encoded "username:password"

	client := &http.Client {}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(body))
}

Java

import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules")
		.newBuilder()
		.addQueryParameter("filter[redirect_from_prefix]", "")
		.addQueryParameter("page", "")
		.addQueryParameter("sort", "");

Request request = new Request.Builder()
		.url(urlBuilder.build())
		.method("GET", null)
		.addHeader("Content-Type", "application/json")
		.addHeader("Authorization", Credentials.basic("your-email", "your-password"))
		.build();
Response response = client.newCall(request).execute();

Nodejs

var axios = require('axios');

var config = {
  method: 'GET',
  url: 'https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules',
  headers: {
	'Content-Type': 'application/json',
	'Authorization': 'Basic <auth-value>', // Base64 encoded "username:password"
  },
  params: {
    'filter[redirect_from_prefix]': '',
    'page': '',
    'sort': '',
  },
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests

url = "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules?filter[redirect_from_prefix]=&page=&sort="
headers = {
	"Content-Type": "application/json",
}

response = requests.request(
	"GET",
	url,
	auth=('<username>', '<password>'),
	headers=headers
)

print(response.text)

Ruby

require "net/http"
uri = URI("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules")
uri.query = URI.encode_www_form("filter[redirect_from_prefix]": "", "page": "", "sort": "")
request = Net::HTTP::Get.new(uri, "Content-Type": "application/json")
request.basic_auth "username", "password"
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
	http.request(request)
end

Example response(s)

200 OK

// Status 200 OK

{
  "meta": {
    "after_cursor": "Y3Vyc29yIHR3bw==",
    "before_cursor": "Y3Vyc29yIG9uZQ==",
    "has_more": true
  },
  "records": [
    {
      "brand_id": "12345",
      "created_at": "2022-10-13T12:00:00.000Z",
      "id": "01GFXGBX7YZ9ASWTCVMASTK8ZS",
      "redirect_from": "/hc/en-us/articles/7654321",
      "redirect_status": "301",
      "redirect_to": "https://help.example.com/account/setting-up-your-account",
      "updated_at": "2022-10-13T12:00:00.000Z"
    }
  ]
}

403 Forbidden

// Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "meta": {},
      "status": "403",
      "title": "Access to the resource is forbidden"
    }
  ]
}

Show Redirect Rule

• GET /api/v2/guide/redirect_rules/{id}

Shows information about the specified redirect rule.

Allowed for

• Guide admins

Parameters

Name	Type	In	Required	Description
id	string	Path	true	The redirect rule id

Code Samples

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/redirect_rules/{id} \
  -v -u {email_address}:{password}

Go

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR"
	method := "GET"
	req, err := http.NewRequest(method, url, nil)

	if err != nil {
		fmt.Println(err)
		return
	}
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Basic <auth-value>") // Base64 encoded "username:password"

	client := &http.Client {}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(body))
}

Java

import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR")
		.newBuilder();

Request request = new Request.Builder()
		.url(urlBuilder.build())
		.method("GET", null)
		.addHeader("Content-Type", "application/json")
		.addHeader("Authorization", Credentials.basic("your-email", "your-password"))
		.build();
Response response = client.newCall(request).execute();

Nodejs

var axios = require('axios');

var config = {
  method: 'GET',
  url: 'https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR',
  headers: {
	'Content-Type': 'application/json',
	'Authorization': 'Basic <auth-value>', // Base64 encoded "username:password"
  },
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests

url = "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR"
headers = {
	"Content-Type": "application/json",
}

response = requests.request(
	"GET",
	url,
	auth=('<username>', '<password>'),
	headers=headers
)

print(response.text)

Ruby

require "net/http"
uri = URI("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR")
request = Net::HTTP::Get.new(uri, "Content-Type": "application/json")
request.basic_auth "username", "password"
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
	http.request(request)
end

Example response(s)

200 OK

// Status 200 OK

{
  "redirect_rule": {
    "brand_id": "12345",
    "created_at": "2022-10-13T12:00:00.000Z",
    "id": "01GFXGBX7YZ9ASWTCVMASTK8ZS",
    "redirect_from": "/hc/en-us/articles/7654321",
    "redirect_status": "301",
    "redirect_to": "https://help.example.com/account/setting-up-your-account",
    "updated_at": "2022-10-13T12:00:00.000Z"
  }
}

403 Forbidden

// Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "meta": {},
      "status": "403",
      "title": "Access to the resource is forbidden"
    }
  ]
}

Set Redirect Rule

• POST /api/v2/guide/redirect_rules

Creates or updates a redirect rule for the URL specified in redirect_from. If there's already a redirect rule for the redirect_from URL, the request updates the redirect_to and redirect_status properties.

Some help center URLs such as for articles, topics, and posts, may have a slug appended to them. Omit the slug from the URL in redirect_from. For example, if the article has a URL of /hc/en-us/articles/123456-Installation-and-setup, then specify:

"redirect_from": "/hc/en-us/articles/123456"

This allows you to redirect any request for that article regardless of the slug. Read more about the help center URL structure in Zendesk help.

Allowed for

• Guide admins

Example body

{
  "redirect_rule": {
    "redirect_from": "/hc/en-us/articles/123",
    "redirect_status": 301,
    "redirect_to": "https://support.example.com/hc/en-us/456"
  }
}

Code Samples

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/redirect_rules \
  -X POST -d '{ "redirect_rule": { "redirect_from": "/hc/en-us/articles/9", "redirect_to": "https://example.com", "redirect_status": 301 } }' \
  -H "Content-Type: application/json" \
  -v -u {email_address}:{password}

Go

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	url := "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules"
	method := "POST"
	payload := strings.NewReader(`{
  "redirect_rule": {
    "redirect_from": "/hc/en-us/articles/123",
    "redirect_status": 301,
    "redirect_to": "https://support.example.com/hc/en-us/456"
  }
}`)
	req, err := http.NewRequest(method, url, payload)

	if err != nil {
		fmt.Println(err)
		return
	}
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Basic <auth-value>") // Base64 encoded "username:password"

	client := &http.Client {}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(body))
}

Java

import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules")
		.newBuilder();
RequestBody body = RequestBody.create(MediaType.parse("application/json"),
		"""
{
  \"redirect_rule\": {
    \"redirect_from\": \"/hc/en-us/articles/123\",
    \"redirect_status\": 301,
    \"redirect_to\": \"https://support.example.com/hc/en-us/456\"
  }
}""");

Request request = new Request.Builder()
		.url(urlBuilder.build())
		.method("POST", body)
		.addHeader("Content-Type", "application/json")
		.addHeader("Authorization", Credentials.basic("your-email", "your-password"))
		.build();
Response response = client.newCall(request).execute();

Nodejs

var axios = require('axios');
var data = JSON.stringify({
  "redirect_rule": {
    "redirect_from": "/hc/en-us/articles/123",
    "redirect_status": 301,
    "redirect_to": "https://support.example.com/hc/en-us/456"
  }
});

var config = {
  method: 'POST',
  url: 'https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules',
  headers: {
	'Content-Type': 'application/json',
	'Authorization': 'Basic <auth-value>', // Base64 encoded "username:password"
  },
  data : data,
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests
import json

url = "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules"

payload = json.loads("""{
  "redirect_rule": {
    "redirect_from": "/hc/en-us/articles/123",
    "redirect_status": 301,
    "redirect_to": "https://support.example.com/hc/en-us/456"
  }
}""")
headers = {
	"Content-Type": "application/json",
}

response = requests.request(
	"POST",
	url,
	auth=('<username>', '<password>'),
	headers=headers,
	json=payload
)

print(response.text)

Ruby

require "net/http"
uri = URI("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules")
request = Net::HTTP::Post.new(uri, "Content-Type": "application/json")
request.body = %q({
  "redirect_rule": {
    "redirect_from": "/hc/en-us/articles/123",
    "redirect_status": 301,
    "redirect_to": "https://support.example.com/hc/en-us/456"
  }
})
request.basic_auth "username", "password"
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
	http.request(request)
end

Example response(s)

204 No Content

// Status 204 No Content

null

403 Forbidden

// Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "meta": {},
      "status": "403",
      "title": "Access to the resource is forbidden"
    }
  ]
}

Delete Redirect Rule

• DELETE /api/v2/guide/redirect_rules/{id}

Deletes the specified redirect rule.

Allowed for

• Guide admins

Parameters

Name	Type	In	Required	Description
id	string	Path	true	The redirect rule id

Code Samples

curl

curl https://{subdomain}.zendesk.com/api/v2/guide/redirect_rules/{id} \
    -X DELETE \
    -v -u {email_address}:{password}

Go

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	url := "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR"
	method := "DELETE"
	req, err := http.NewRequest(method, url, nil)

	if err != nil {
		fmt.Println(err)
		return
	}
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Basic <auth-value>") // Base64 encoded "username:password"

	client := &http.Client {}
	res, err := client.Do(req)
	if err != nil {
		fmt.Println(err)
		return
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		fmt.Println(err)
		return
	}
	fmt.Println(string(body))
}

Java

import com.squareup.okhttp.*;
OkHttpClient client = new OkHttpClient();
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR")
		.newBuilder();

Request request = new Request.Builder()
		.url(urlBuilder.build())
		.method("DELETE", null)
		.addHeader("Content-Type", "application/json")
		.addHeader("Authorization", Credentials.basic("your-email", "your-password"))
		.build();
Response response = client.newCall(request).execute();

Nodejs

var axios = require('axios');

var config = {
  method: 'DELETE',
  url: 'https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR',
  headers: {
	'Content-Type': 'application/json',
	'Authorization': 'Basic <auth-value>', // Base64 encoded "username:password"
  },
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests

url = "https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR"
headers = {
	"Content-Type": "application/json",
}

response = requests.request(
	"DELETE",
	url,
	auth=('<username>', '<password>'),
	headers=headers
)

print(response.text)

Ruby

require "net/http"
uri = URI("https://your_account_subdomain.zendesk.com/api/v2/api/v2/guide/redirect_rules/01GFYBENPDGN1R6NAA4WRDNVFR")
request = Net::HTTP::Delete.new(uri, "Content-Type": "application/json")
request.basic_auth "username", "password"
response = Net::HTTP.start uri.hostname, uri.port, use_ssl: true do |http|
	http.request(request)
end

Example response(s)

204 No Content

// Status 204 No Content

null

403 Forbidden

// Status 403 Forbidden

{
  "errors": [
    {
      "code": "Forbidden",
      "meta": {},
      "status": "403",
      "title": "Access to the resource is forbidden"
    }
  ]
}