KB489559: How to update ‘View in Browser‘ link URL for email subscription notifications

Symptom

The URL in ‘View in Browser’ is generated based on a subscription host URL, which is an email setting saved in the custom application: subscriptionHost.

Currently, this setting is not exposed in the application editor GUI, its default value is the Library URL of created application in current environment connected in Workstation.

Solution

We can use custom application REST API to modify the subscriptionHost setting after an application was created.

A new subscription / new template will then be generated with updated subscription host URL. You can use the Swagger page or Postman tool, there are mainly two steps:

Step 1: Retrieve Application Configuration

• Use the following API to retrieve the complete configuration:

GET /api/v2/applications/{id}

• Please refer to the Swagger example for the request format below.

• Ensure that the outputFlag parameter includes both INCLUDE_LOCAL and INCLUDE_ACL, as these fields are necessary for the update operation.
• This endpoint will return the full application JSON configuration.

Step 2: Update Application Configuration

• In the retrieved configuration, locate the following field:

emailSettings → subscriptionHost

• Update the subscriptionHost to the new desired Library URL. (Note: The target Library should use the same Intelligence Server to ensure they share the application in the metadata).

• Use the following API to update the application:

PUT /api/v2/applications/{id}

• Supply the complete application JSON configuration as the request body.

After this update, any URLs generated in emails by the distribution service will use the updated subscriptionHost URL specified in the application.