API Reference

Creates a new link monitor.

post
https://platform.routy.app/api/v1/link-monitors

Requires the EditLinkMonitor policy. Provide exactly one of BrandLinkId or
CustomUrl as the monitoring target. Any supplied GeoLocations must be supported
ISO 2-letter country codes (see GET /link-monitors/geo-locations). The monitor is created
in PendingSync status and a sync request is dispatched to register it with the external
provider. On success the response body carries the new monitor id and a Location header
pointing at the monitor resource.

🔐 Required permissions: link-monitor.read, link-monitor.update

🚩 Requires feature: link_monitor

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The monitor configuration to create.

Request to create a new link monitor.

string
required
length between 1 and 200

User-friendly name for this monitor.

string | null

Optional description.

int32 | null

Reference to an existing brand link to monitor.
Either BrandLinkId or CustomUrl must be provided, but not both.

uri | null

Custom URL to monitor.
Either BrandLinkId or CustomUrl must be provided, but not both.

string | null

Cron expression defining how often to check the link.
Examples: "0 * * * " (hourly), "0 /6 * * " (every 6 hours), "0 0 * *" (daily).
Defaults to daily at midnight.

string
enum

What to monitor on the link. Can be combined as flags.

Allowed:
geoLocations
array of strings | null

Geographic locations to test from (ISO 2-letter country codes).
If not specified, default location will be used.

geoLocations
boolean

When true, captures a page screenshot and the rendered DOM for each detected change
(uses the browser fetcher). Off by default.

boolean

When true, captures an AI-generated summary of each detected change. Off by default
(incurs LLM cost and sends page content to the configured AI provider).

string | null

Optional AI prompt/rule for the summary (e.g. "flag if the offer expired"). When empty, a
default prompt is used. Only applies when SummarizeChanges is true.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 2 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 2 days ago