API reference
Update a watch
Changes the name, buyer profile, schedule, caps, webhook or status. Send only the fields you want to change. `buyer_profile` and `schedule` are replaced as a whole. `signal`, `exclude_companies` and `just_outside` are fixed: create a new watch instead. `status` `paused` pauses it (`paused_reason` `user`); `status` `active` resumes it. Raising `max_credits_per_month` resumes a watch paused for `monthly_cap`.
Changes the name, buyer profile, schedule, caps, webhook or status. Send only the fields you want to change. buyer_profile and schedule are replaced as a whole. signal, exclude_companies and just_outside are fixed: create a new watch instead. status paused pauses it (paused_reason user); status active resumes it. Raising max_credits_per_month resumes a watch paused for monthly_cap.
Authentication
Send Authorization: Bearer gtk_…. Create the key under API Access → API Keys. A missing, invalid or revoked key is 401, including while this API is closed. A valid key while the API is closed for your organization answers 404, the same body as an unknown path. Every response includes FounderMCP-Api-Version and FounderMCP-Request-Id.
Path parameters
watch_idstring· required — The watch to change.
Body parameters
namestring | null— Up to 120 characters.buyer_profileobject— Replaces the buyer profile.scheduleobject— Replaces the schedule.max_leads_per_runinteger— 1 to 50.max_credits_per_monthinteger— 1 to 1,000,000.webhook_endpoint_idstring | null— A webhook endpoint, or null to clear it.statusstring—activeorpaused. One of:active,paused.
Response
idstring· required — Watch id,wtch_….objectstring· required — Alwayswatch. One of:watch.statusstring· required —active,pausedordeleted. One of:active,paused,deleted.paused_reasonstring | null—user,monthly_cap,daily_cap,webhook_disabledorsource_unavailable.signalobject· required — The signal, fixed after create.scheduleobject· required —frequency(daily,weekly,event_lifecycle),weekday,hour_local,timezone.max_leads_per_runinteger· required — Cap on new leads per run.max_credits_per_monthinteger· required — Cap for the Brussels calendar month.next_run_atstring | null· required — When the next run starts. Null while you paused it, or while its webhook is disabled.statsobject· required —leads_delivered_totalandcredits_this_month.
Credits
Free. Later runs still charge per new lead.
Errors
- 409
invalid_state— The watch is deleted, its webhook is still disabled, or it already used its monthly cap. - 400
invalid_request— The body is not valid JSON, a field is unknown or has the wrong type, or a value is not allowed. - 401
authentication_error— The Authorization header is missing, or the key is unknown or revoked. - 403
permission_error— API access is not part of your plan, or your account is suspended. - 404
not_found— The endpoint does not exist. - 429
rate_limit_error— More than 60 requests per minute, or more than 3 at the same time, on one key. Wait for the Retry-After header. - 429
daily_limit_reached— The request could take your organization over its daily credit limit. The limit resets at midnight (Europe/Brussels). - 402
insufficient_credits— The credit balance is lower than this request could cost. Nothing was charged. Add credits, or send a smaller request. The error includes code, fix and a link to the credits docs. - 502
upstream_error— The data source did not answer. Retry later. - 503
service_unavailable— The API is temporarily unavailable. Retry later. - 500
internal_error— Something went wrong on our side. - 402
max_credits_exceeded— max_credits is lower than the credits of the first row, so nothing could be returned. Nothing was charged; raise max_credits or ask for fewer rows.
Example
cURL
curl -X PATCH "https://foundermcp.dev/api/v1/watches/wtch_01J9Z6P8C8V0K3W6T2N8R5M1XD" \
-H "Authorization: Bearer $FOUNDERMCP_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "paused"
}'
JavaScript
const response = await fetch('https://foundermcp.dev/api/v1/watches/wtch_01J9Z6P8C8V0K3W6T2N8R5M1XD', {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.FOUNDERMCP_API_KEY}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
"status": "paused"
})
});
const body = await response.json();
Python
import json
import os
import urllib.request
payload = {
"status": "paused"
}
request = urllib.request.Request(
"https://foundermcp.dev/api/v1/watches/wtch_01J9Z6P8C8V0K3W6T2N8R5M1XD",
headers={
"Authorization": f"Bearer {os.environ['FOUNDERMCP_API_KEY']}",
"Content-Type": "application/json"
},
data=json.dumps(payload).encode(),
method="PATCH",
)
with urllib.request.urlopen(request) as response:
body = json.load(response)
Example response
{
"id": "wtch_01J9Z6P8C8V0K3W6T2N8R5M1XD",
"object": "watch",
"status": "paused",
"paused_reason": "user"
}