Act on a signal event
Act on an event: build a lead list, optionally a campaign parked at Preview.
POST/api/v1/events/{id}/act
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Body
A JSON object. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
action | body | lead_list_only or lead_list_and_campaign. One of lead_list_only, lead_list_and_campaign. |
requested_count | body, integer | Leads to source from the company. |
source | body | apollo (default), moltsets or leadocean; another is used when the chosen one has no key or credit. One of apollo, moltsets, leadocean. |
options | body, object | What to enrich and the model per AI step, as on a lead search: verify, phone, research, posts (true or false), profile_tier (none, cheap, full), models ({ step: slug }). |
copy_models | body, object | With a campaign: the model per copy step ({ lead_copy, campaign_template }). |
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/events/{id}/act" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"action": "lead_list_only",
"requested_count": 0,
"source": "apollo",
"options": {},
"copy_models": {}
}'CLI
sales-engine events act <id>The JSON above lists every documented field with a typed placeholder; send only the ones you mean.
Response
A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.
Shape
{
"data": { ... }
}Run it below to see the live shape for your workspace.
Try it
Runs against this server, as the workspace behind the key. Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
requiredThe record's id.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/events/%7Bid%7D/act
Fill the path first.