Watchlists

Update watchlist

Partially update a watchlist owned by the organization associated with the API key. Only provided fields will be updated.

patch/v1/api/watchlists/{id}

Request

  • Base URL: https://api.perigon.io
  • URL: https://api.perigon.io/v1/api/watchlists/{id}
  • Auth: HTTP bearer

Path parameters

idinteger required

Request body

namestring nullable

New name for the watchlist

displayNamestring nullable

New display name for the watchlist

descriptionstring nullable

New description for the watchlist

visibleboolean nullable

Whether the watchlist is visible in the UI

Response

200 - Success

Example response

{
  "data": {
    "id": 42,
    "createdAt": "2025-06-01T09:00:00.000Z",
    "updatedAt": "2025-08-01T16:30:00.000Z",
    "name": "ai-executives",
    "displayName": "AI Executives",
    "description": "Leadership at major AI companies.",
    "people": [
      {
        "name": "Sam Altman",
        "description": "CEO of OpenAI",
        "wikidataId": "Q7411063",
        "aliases": []
      }
    ],
    "companies": [
      {
        "name": "OpenAI",
        "description": "AI research company",
        "id": "openai",
        "domain": "openai.com",
        "aliases": []
      }
    ],
    "organizationId": 1001,
    "visible": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.