# Prospect routes: update, delete

URL: /code/api/prospect/records-update · Id: `page:code/api/prospect/records-update`

> The Prospect Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for [Prospect](/business/nouns/prospect), one group of [Prospect routes](/code/api/prospect).

### Prospect.update
Changes the given properties of a Prospect. [Verb page](/business/nouns/prospect/update?interface=api).

```text
PATCH /{namespace}/prospects/{id}
```

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

**Inputs**

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

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `prospect` | [Prospect](/business/nouns/prospect) | Yes | The Prospect. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
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](/business/nouns/prospect/delete?interface=api).

```text
DELETE /{namespace}/prospects/{id}
```

Path: `id`. Emits `Prospect.deleted`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Prospect. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `prospect` | [Prospect](/business/nouns/prospect) | Yes | The Prospect. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X DELETE https://api.sb/leaseline.app/prospects/prospect_S8bqJCxC9R \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```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.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```