Skip to content

Lead.assign

Gives a lead one owner seat, by round robin, territory or ICP fit, as your routing rule says.

Action class
None
Approval
Runs on its own
Emits
Lead.assigned
Price
Free
POST https://api.sb/{your-domain}/leads/{lead}/assign

Its Inputs, Outputs, Effects and guards quote the hub’s Lead.assign; this page adds what each Venue honors, its limits and a worked call. It is one of the Verbs of CRM.

Inputs

NameTypeMeaning
leadLeadRequired. The lead to route.
ownerWorkerThe Worker to own it; omitted, the routing Policy picks. Optional.

Outputs

FieldTypeWhat null means
leadLeadNever null: the lead, with its owner.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Runs every check and returns the record as it would be; nothing is stored.
  • send: Returns a pending Action at once; Lead.assigned fires when it is done.
  • do: Waits for the Action to finish and returns the record.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409.

Saved or shared

The lead is saved as the call leaves it, with the Action that changed it.

Emits

Lead.assigned with { lead }

Performed by

Sales lead

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

It acts on your own records and reaches no Venue, so every account answers the same way.

What try does

Runs every check the call meets and returns the record as it would be; nothing is stored, sent or posted.

Refuses when

The hub sets no guard of its own on this call: it refuses only on the shared checks every write meets (a missing record, a Permission the seat lacks).

When it waits

Returns in one response; nothing waits.

Example

In send mode the call returns its pending Action at once, and Lead.assigned delivers the result.

You, to your agent
Give the Harborview lead to my AE seat.
Response, in send mode
{
  "mode": "send",
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/action_Sd3kQ9vT2w",
    "operation": "Lead.assign",
    "status": "pending",
    "reason": "running"
  }
}

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Used by