Update Home Page Redirect URL

u301.domains.updateHomePageRedirectUrl

import { U301 } from 'u301';

const apiKey = '<YOUR_API_KEY>';
const workspaceId = '<YOUR_WORKSPACE_ID>';

const u301 = new U301({
 apiKey,
 workspaceId,
});
const homePageRedirectUrl = 'https://example.com';
const isSuccess = await u301.domains.updateHomePageRedirectUrl('t.example.com', homePageRedirectUrl); // [!code highlight]
console.log(isSuccess);

the response

Request

Name	Location	Type	Description
Authorization	Header	`string`	`Bearer` token used for authentication.
workspaceId	Query	`string`	Workspace identifier for multi‑tenant routing.
domain	Path	`string`	Domain for the short link.
homePageRedirectUrl	Body	`string`	The destination URL where users will be redirected when they visit your domain.

Response

Return { success: true } on success, or throw an error if the update failed.

Name	Type	Description
success	`boolean`	Whether the update was successful.

response-example.json

{
  "success": true
}

Update Home Page Redirect URL

Request

Response

On this page