Skip to content

Lead programs: update, delete

The Lead Verbs update, delete as MCP do programs, with inputs, result, refusals and an example.

Reference for Lead, one group of Lead programs.

Lead.update

Changes the given properties of a Lead. Verb page.

Text
do: return await $.Lead.update(input)

Emits Lead.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Lead.
emailemailThe primary email address.
phonestringThe primary phone number.
namestringThe name the Contact goes by.
interesttextWhat the Lead asked for.
ownerWorkerThe Worker who answers it.

Returns

OutputTypeRequiredDescription
leadLeadrequiredThe Lead.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

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

Lead.delete

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

Text
do: return await $.Lead.delete(input)

Emits Lead.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Lead.

Returns

OutputTypeRequiredDescription
leadLeadrequiredThe Lead.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

JSON
{
  "name": "do",
  "arguments": {
    "code": "return await $.Lead.delete({ id: 'lead_Kz1R9fhqzZ' })"
  }
}