Sign in
latestOpenAPI 3.0.32026-08-08360156.4 KB

ae7fddf16bf9

Signals

Update a monitor

Updates an existing monitor. The signal_type cannot be changed after creation.

patch/api/signals/monitors/{id}

Request body

namestring required

The monitor name.

keywordsstring[]

Keywords to track (required for keyword_mention, nullable otherwise, max 5).

webhook_urlstring

Optional HTTPS URL to receive webhook notifications.

engagement_typesstring[]

Engagement types to track (required for post_engagement). Accepted values: like, comment.

enrichment_levelstring

Contact enrichment level. Accepted values: email, email_phone.

lead_list_idinteger

ID of a lead list to automatically add matched contacts to.

ai_relevance_promptstring

Optional custom prompt used to score AI relevance of matched signals (max 500 chars).

target_companiesstring[]

Target companies (names or domains) to filter signals (max 100). Only accepted for new_hire and job_change — returns 422 for any other signal type.

is_sharedboolean

Optional opt-in flag to share/unshare the monitor with the user's current team. Only owner or team admin can change sharing.

job_offer_title_keywordsstring[]

Job offer title keywords (company_hiring only, max 10).

Example request

{
  "name": "Updated monitor name",
  "keywords": [
    "hiring",
    "fundraise"
  ],
  "webhook_url": "https://example.com/webhooks/signals",
  "enrichment_level": "email",
  "lead_list_id": 42,
  "ai_relevance_prompt": "Focus on Series B+ SaaS companies hiring VP Sales.",
  "is_shared": true,
  "icp_filters": {
    "industries": [
      "Biotechnology"
    ],
    "employee_count_ranges": [
      "51-200"
    ],
    "countries": [
      "US",
      "FR"
    ],
    "job_title_keywords": [
      "VP Sales"
    ],
    "seniority_levels": [
      11,
      13
    ]
  }
}

Response

Ok

idinteger
namestring
signal_typestring
signal_type_labelstring
signal_levelstring
statusstring
keywordsstring[]
icp_filtersstring nullable
webhook_urlstring nullable
webhook_paused_atstring nullable
post_urlstring nullable
profile_urlstring nullable
engagement_typesstring nullable
enrichment_levelstring nullable
lead_list_idstring nullable
ai_relevance_promptstring nullable
target_companiesstring nullable
match_countinteger
is_sharedboolean
is_ownerboolean
is_team_ownerboolean
user_idinteger
owner_namestring
created_atstring

Example response

{
  "id": 1,
  "name": "Updated monitor name",
  "signal_type": "keyword_mention",
  "signal_type_label": "Keyword Mention",
  "signal_level": "contact",
  "status": "active",
  "keywords": [
    "hiring",
    "fundraise"
  ],
  "icp_filters": null,
  "webhook_url": null,
  "webhook_paused_at": null,
  "post_url": null,
  "profile_url": null,
  "engagement_types": null,
  "enrichment_level": null,
  "lead_list_id": null,
  "ai_relevance_prompt": null,
  "target_companies": null,
  "match_count": 42,
  "is_shared": true,
  "is_owner": true,
  "is_team_owner": false,
  "user_id": 42,
  "owner_name": "Jane Doe",
  "created_at": "2026-02-01T10:00:00.000000Z"
}