Update a redirect

Endpoint

PUT /update/{id}

Function signature

export const updateRedirect = async (data: UpdateRedirectProps): Promise<AxiosResponse>

Request body

string

required

The ID of the redirect to be updated

string

required

The new domain to which the redirect points

RedirectType

required

The type of redirect. Must be either permanent or temporary

boolean

required

Indicates whether the path should be forwarded

boolean

required

Indicates whether the query parameters should be forwarded

number

required

The sampling rate for analytics. Must be a value between 0 and 1

Type definitions

type UpdateRedirectProps = {
  id: string;
  toDomain: string;
  redirectType: RedirectType;
  pathForwarding: boolean;
  queryForwarding: boolean;
  samplingRate: number;
};

enum RedirectType {
  Permanent = 'permanent',
  Temporary = 'temporary',
}

The fromDomain cannot be updated. To change the source domain, you must delete the redirect and create a new one.

Response

number

HTTP status code

object

The updated redirect object

Code example

import { updateRedirect } from '@/lib/api';
import { RedirectType } from '@/lib/constants';

const updateExistingRedirect = async (redirectId: string) => {
  const response = await updateRedirect({
    id: redirectId,
    toDomain: 'updated-domain.com',
    redirectType: RedirectType.Permanent,
    pathForwarding: true,
    queryForwarding: true,
    samplingRate: 1.0
  });
  
  return response.data;
};

import { updateRedirect } from '@/lib/api';
import { RedirectType } from '@/lib/constants';

// Change from temporary to permanent redirect
const makeRedirectPermanent = async (redirectId: string, currentToDomain: string) => {
  const response = await updateRedirect({
    id: redirectId,
    toDomain: currentToDomain,
    redirectType: RedirectType.Permanent,
    pathForwarding: true,
    queryForwarding: true,
    samplingRate: 1.0
  });
  
  return response.data;
};

import { updateRedirect } from '@/lib/api';
import { RedirectType } from '@/lib/constants';

// Reduce analytics sampling to 25%
const reduceSampling = async (redirect: any) => {
  const response = await updateRedirect({
    id: redirect.id,
    toDomain: redirect.toDomain,
    redirectType: redirect.redirectType,
    pathForwarding: redirect.pathForwarding,
    queryForwarding: redirect.queryForwarding,
    samplingRate: 0.25
  });
  
  return response.data;
};

Error responses

Show 400 - Bad Request

Returned when the request body is invalid or missing required fields

Show 401 - Unauthorized

Returned when the user is not authenticated

Show 403 - Forbidden

Returned when the user does not have permission to update this redirect

Show 404 - Not Found

Returned when the redirect with the specified ID does not exist

Show 500 - Internal Server Error

Returned when an unexpected error occurs on the server

Getting Started

Redirects

Analytics

Rules

Payment & Billing

Endpoint

Function signature

Request body

Type definitions

Response

Code example

Error responses

​Endpoint

​Function signature

​Request body

​Type definitions

​Response

​Code example

​Error responses

Endpoint

Function signature

Request body

Type definitions

Response

Code example

Error responses