Skip to content

by Startups.Studio

Growth Contact Lead

Lead.update

PATCH /{namespace}/leads/{id}

Changes the given properties of a Lead.

Noun: Lead
Mode: do
Event: Lead.updated

You, to your agent

Change the latest lead.

curl -X PATCH https://api.sb/ledgerlark.com/leads/lead_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"owner":"worker_1"}'

import { $ } from 'startup-builder'

const lead = await $.Lead.update({ id: 'lead_1', owner: 'worker_1' })

npx startup-builder do Lead.update --json '{"id":"lead_1","owner":"worker_1"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Lead.update({ id: 'lead_1', owner: 'worker_1' })"
  }
}

Update changes the given properties of a Lead. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Lead.
`email`	`email`		The primary email address.
`phone`	`string`		The primary phone number.
`name`	`string`		The name the Contact goes by.
`interest`	`text`		What the Lead asked for.
`owner`	Worker		The Worker who answers it.

Outputs

Output	Type	Required	Description
`lead`	Lead	required	The Lead.

Effects

Emits Lead.updated.
Two-way: try, send, do.

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.update

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.qualify

Previous Page

Content

Next Page