Skip to content

by Startups.Studio

Growth Contact Lead

Lead.assign

POST /{namespace}/leads/{lead}/assign

Assign gives a Lead one owner Worker, by round robin, territory or ICP fit, as the Startup’s routing Policy says.

Noun: Lead
Mode: do
Event: Lead.assigned

You, to your agent

Assign the latest lead.

curl -X POST https://api.sb/ledgerlark.com/leads/lead_1/assign \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"

import { $ } from 'startup-builder'

const lead = await $.Lead.assign({ lead: 'lead_1' })

npx startup-builder do Lead.assign --json '{"lead":"lead_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Lead.assign({ lead: 'lead_1' })"
  }
}

Inputs

Input	Type	Required	Description
`lead`	Lead	required	The Lead to route.
`owner`	Worker		The Worker to own it; omitted, the routing Policy picks.

Outputs

Output	Type	Required	Description
`lead`	Lead	required	The Lead, with its owner.

Effects

Emits Lead.assigned.
Performed by the Sales Lead.
Two-way: it runs at once, in the try, send and do modes.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Lead.assign

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Lead

Previous Page

Lead.convert

Next Page