Skip to main content
POST
/
api
/
public
/
announcements
/
visitUrl
{
  "Url": "<string>"
}

​
Announcement URL Visit

Records that a customer clicked through on an announcement’s external URL. Used for tracking engagement with announcements.

​
Authentication

Requires a valid customer bearer token.

​
Query Parameters

​
id
number
required
Numeric identifier of the announcement.

​
Response

Returns the external URL to open in the browser.
​
Url
string
required
The external URL associated with the announcement. The portal opens this in a new tab via window.open().

​
Examples

​
Track announcement click

POST /api/public/announcements/visitUrl?id=10
Authorization: Bearer {token}

{
  "Url": "https://example.com/promo"
}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const response = await httpClient.post<{ Url: string }>(endpoints.announcements.url(10))
window.open(response.data.Url, '_blank')