Skip to content

Prospect programs: update, delete

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

Reference for Prospect, one group of Prospect programs.

Prospect.update

Changes the given properties of a Prospect. Verb page.

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

Emits Prospect.updated.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Prospect.
foundInstringWhere the Startup found them.
basisstringThe basis on record for contacting them.

Returns

OutputTypeRequiredDescription
prospectProspectrequiredThe Prospect.

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 $.Prospect.update({ id: 'prospect_S8bqJCxC9R', foundIn: 'Example found in' })"
  }
}

Prospect.delete

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

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

Emits Prospect.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Prospect.

Returns

OutputTypeRequiredDescription
prospectProspectrequiredThe Prospect.

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 $.Prospect.delete({ id: 'prospect_S8bqJCxC9R' })"
  }
}