Skip to content

Template routes: update, delete

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

Reference for Template, one group of Template routes.

Template.update

Changes the given properties of a Template. Verb page.

Text
PATCH /{namespace}/templates/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Template.
bodytextThe MDX source with its variables.

Returns

OutputTypeRequiredDescription
templateTemplaterequiredThe Template.

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

Terminal
curl -X PATCH https://api.sb/leaseline.app/templates/template_THRQF1h9uX \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"Example body"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "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.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Template.delete

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

Text
DELETE /{namespace}/templates/{id}

Path: id. Emits Template.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Template.

Returns

OutputTypeRequiredDescription
templateTemplaterequiredThe Template.

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

Terminal
curl -X DELETE https://api.sb/leaseline.app/templates/template_THRQF1h9uX \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "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.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}