# Template routes: extend, promote, upgrade

URL: /code/api/template/verbs · Id: `page:code/api/template/verbs`

> The Template Verbs extend, promote, upgrade as api.sb routes, with inputs, result, refusals and an example.

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

### Template.extend
Extend adds a Template to a Startup’s bases, pinned to a Version, so the Startup inherits its definition. [Verb page](/business/nouns/template/extend?interface=api).

```text
POST /{namespace}/templates/{template}/extend
```

Path: `template`. Body, as JSON: the other inputs. Emits [`Template.extended`](/business/events/Template.extended).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | [Template](/business/nouns/template) | Yes | The Template to inherit. |
| `startup` | [Startup](/business/nouns/startup) | Yes | The Startup that extends it. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `startup` | [Startup](/business/nouns/startup) | Yes | The Startup with the Template among its bases. |
| `template` | [Template](/business/nouns/template) | Yes | The Template extended. |

**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. |
| The record is not in a state that allows this Verb, so the call is refused. | [`refused`](/code/api/errors/refused) | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |
| A clash between two bases until the Startup settles it | [`refused`](/code/api/errors/refused) | Clear what the check names, then call it again. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/templates/template_THRQF1h9uX/extend \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_l3hr1EnUGY"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "template": {
    "$id": "https://api.sb/leaseline.app/templates/template_THRQF1h9uX",
    "$type": "Template",
    "body": "Example body"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Template.extend",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Template.promote
Promote moves one Startup’s refinement into a Template, so every Startup that extends the Template inherits it. [Verb page](/business/nouns/template/promote?interface=api).

```text
POST /{namespace}/templates/{template}/promote
```

Path: `template`. Body, as JSON: the other inputs. Emits [`Template.promoted`](/business/events/Template.promoted).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | [Template](/business/nouns/template) | Yes | The Template that receives the refinement. |
| `startup` | [Startup](/business/nouns/startup) | Yes | The Startup that holds the refinement. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `change` | [Change](/business/nouns/change) | Yes | The Change against the Template. |
| `template` | [Template](/business/nouns/template) | Yes | The Template that received the refinement. |

**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. |
| The record is not in a state that allows this Verb, so the call is refused. | [`refused`](/code/api/errors/refused) | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/templates/template_THRQF1h9uX/promote \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_l3hr1EnUGY"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "change": {
    "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
    "$type": "Change",
    "status": "Open",
    "base": "version_4HTEMs14G4"
  },
  "template": {
    "$id": "https://api.sb/leaseline.app/templates/template_THRQF1h9uX",
    "$type": "Template",
    "body": "Example body"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Template.promote",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Template.upgrade
Upgrade moves a Startup to a newer Version of a Template it extends, through a Change it can review. [Verb page](/business/nouns/template/upgrade?interface=api).

```text
POST /{namespace}/templates/{template}/upgrade
```

Path: `template`. Body, as JSON: the other inputs. Emits [`Template.upgraded`](/business/events/Template.upgraded).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `template` | [Template](/business/nouns/template) | Yes | The Template to upgrade. |
| `startup` | [Startup](/business/nouns/startup) | Yes | The Startup that extends it. |
| `version` | [Version](/business/nouns/version) | No | The target Version. Defaults to the latest. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `change` | [Change](/business/nouns/change) | Yes | The Change that moves the pin. |
| `template` | [Template](/business/nouns/template) | Yes | The Template upgraded to. |

**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. |
| The record is not in a state that allows this Verb, so the call is refused. | [`refused`](/code/api/errors/refused) | Read the record, run the Verb that moves it to an allowed state, then retry. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/templates/template_THRQF1h9uX/upgrade \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_l3hr1EnUGY"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "change": {
    "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
    "$type": "Change",
    "status": "Open",
    "base": "version_4HTEMs14G4"
  },
  "template": {
    "$id": "https://api.sb/leaseline.app/templates/template_THRQF1h9uX",
    "$type": "Template",
    "body": "Example body"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Template.upgrade",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```