API reference · Watchlists and webhooks

Change a watchlist's name, webhook or email alerts

PATCH/v1/watchlists/{id}

Example request

Shell

curl -X PATCH "https://api.adlibapi.com/v1/watchlists/0b7c6a8e-1f2d-4c3b-9a8e-5d6f7a8b9c0d" \
  -H "X-API-Key: $ADLIB_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Competitors","webhook_url":"https://hooks.example.com/adlib"}'

Send your key in the X-API-Key header. Try it in the explorer.

Parameters

idrequired

path · string

–

Request body

email_alerts

boolean

Mail a digest of each crawl's changes to your account's email

name

string

–

webhook_url

string

New webhook URL (Slack and Discord webhooks get a readable message); empty string removes it

Response

data.advertiser_countrequired

integer

–

data.advertisersrequired

object[]

Empty in the list endpoint; GET /v1/watchlists/{id} has the entries

active_ads_known

integer

–

advertiser_id

string

–

last_crawl_at

datetime

–

last_error

string

–

name

string

–

next_crawl_at

datetime

–

data.archive_videosrequired

boolean

–

data.created_atrequired

datetime

–

data.email_alertsrequired

boolean

A digest of each crawl's changes goes to the account's email

data.idrequired

string

–

data.interval_hoursrequired

integer

Crawl interval, as set with interval_hours on create

data.namerequired

string

–

data.webhook_urlrequired

string

–