Prospect routes: update, delete

Reference for Prospect, one group of Prospect routes.

Prospect.update

Changes the given properties of a Prospect. Verb page.

Text

PATCH /{namespace}/prospects/{id}

Path: id. Body, as JSON: the other inputs. Emits Prospect.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Prospect.
`foundIn`	`string`		Where the Startup found them.
`basis`	`string`		The basis on record for contacting them.

Returns

Output	Type	Required	Description
`prospect`	Prospect	required	The Prospect.

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

Terminal

curl -X PATCH https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"foundIn":"Example found in"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "prospect": {
    "$id": "https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R",
    "$type": "Prospect",
    "foundIn": "Example found in",
    "basis": "Example basis"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Prospect.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Prospect.delete

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