Skip to main content
POST
/
api
/
v1
/
signal
/
deploy
/
competitor-engagement-agent
Deploy Competitor Engagement Signal
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/signal/deploy/competitor-engagement-agent \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "name": "<string>",
  "linkedin_url": "<string>",
  "timeframe": 7,
  "icp_id": 123,
  "repeat": false,
  "account_audience_name": "<string>",
  "people_audience_name": "<string>",
  "max_credit_limit": 123,
  "enable_safe_crm_addition": false,
  "auto_enrich_people_emails": false
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

​
X-API-Key
string
required
​
X-User-ID
string
required

Body

application/json
​
name
string
required

Name/identifier for this signal run

​
linkedin_url
string
required

LinkedIn profile URL to monitor for engagement

​
timeframe
integer | null
default:7

Time limit in days (1-180)

Required range: 1 <= x <= 180
​
icp_id
integer | null

ICP ID to use for filtering

​
repeat
boolean | null
default:false

Whether this signal should recur daily

​
account_audience_name
string | null

Audience name for auto-adding discovered accounts

​
people_audience_name
string | null

Audience name for people enrichment

​
max_credit_limit
integer | null

Credit limit to enforce on this signal. Signal will stop once max_credit_limit is hit

​
enable_safe_crm_addition
boolean | null
default:false

Auto-add discovered accounts to CRM. New/unassigned accounts are created and assigned to you; existing accounts get signals enriched. Ownership is never changed.

​
auto_enrich_people_emails
boolean | null
default:false

Automatically enrich discovered people with work emails. Requires people_audience_name to be set. Uses email enrichment credits.

Response

Successful Response