---
title: "Add or update a watchlist item by page_url"
method: POST
path: "/api/v1/watchlist"
tags: ["Watchlist"]
---

# Add or update a watchlist item by page_url

`POST /api/v1/watchlist`

## Request

- Base URL: `https://getscaleforge.com`
- URL: `https://getscaleforge.com/api/v1/watchlist`
- Auth: HTTP bearer

Upsert behaviour: if a watchlist item already exists for the given
`page_url` it is updated (status `200 OK`), otherwise created
(status `201 Created`). Requires scope `watchlist:write`.

## Request body

- object
  - `watchlist_item` object, required
    - `page_url` string, uri, required
    - `page_name` string
    - `page_avatar` string, uri
    - `page_id` string
    - `scan_frequency` 'hourly' | 'daily' | 'weekly'
    - `active` boolean

## Response `200`

Existing item updated

- object
  - `watchlist_item` object
    - `id` integer
    - `page_url` string, uri
    - `page_name` string, nullable
    - `page_avatar` string, uri, nullable
    - `page_id` string, nullable
    - `scan_frequency` 'hourly' | 'daily' | 'weekly'
    - `active` boolean
    - `total_ads` integer, nullable
    - `active_ads` integer, nullable
    - `last_scanned_at` string, date-time, nullable
    - `created_at` string, date-time
  - `updated` boolean

## Other responses

- `201`: Created

---

[API](https://skmtc.dev/getscaleforge/apis/scaleforge-api.md) · [All operations](https://skmtc.dev/getscaleforge/apis/scaleforge-api/llms.txt) · [OpenAPI document](https://skmtc.dev/getscaleforge/apis/scaleforge-api/revisions/ca382e62f404?raw)