Lead methods: update, delete

Reference for Lead, one group of Lead methods.

Lead.update

Changes the given properties of a Lead. Verb page.

TypeScript

interface LeadVerbs {
  update(input: LeadUpdateInput, options?: SB.CallOptions): SB.Call<Lead>
}

Emits Lead.updated.

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.

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

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

Deletes a Lead: a soft delete that keeps its history, undone by Thing.restore. Verb page.

TypeScript

interface LeadVerbs {
  delete(input: LeadDeleteInput, options?: SB.CallOptions): SB.Call<Lead>
}

Emits Lead.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Lead.

Returns

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

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

Example

TypeScript

import { $ } from 'startup-builder'

const lead = await $.Lead.delete({ id: 'lead_Kz1R9fhqzZ' })