Startup routes: update, delete
The Startup Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.
Reference for Startup, one group of Startup routes.
Startup.update
Changes the given properties of a Startup. Verb page.
PATCH /{namespace}/ startups/ {id}Path: id. Body, as JSON: the other inputs. Emits Startup.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Startup. |
name | string | The name the Startup trades under. | |
domain | url | The canonical hostname of the Startup. | |
launchedAt | datetime | When the Startup went live. | |
template | string | The slug of the template it extends; the root one when none is named. | |
idea | text | The Idea it starts from, in a sentence, recorded as its Idea. | |
spendState | string | How freely money Limits allow spend: free, tight (discretionary Limits halved) or hold (one-way spend stops). |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The Startup. |
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
curl -X PATCH https: //api.sb/ leaseline.app/ startups/ startup_l3hr1EnUGY \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
-H "Content-Type: application/ json" \
-d '{"name": "Leaseline"}'{
"api": "https: //api.sb/ leaseline.app",
"startup": {
"$id": "https: //api.sb/ leaseline.app/ startups/ startup_l3hr1EnUGY",
"$type": "Startup",
"name": "Leaseline"
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Startup.update",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}Startup.delete
Deletes a Startup: a soft delete that keeps its history, undone by Thing.restore. Verb page.
DELETE /{namespace}/ startups/ {id}Path: id. Emits Startup.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Startup. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
startup | Startup | required | The Startup. |
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
curl -X DELETE https: //api.sb/ leaseline.app/ startups/ startup_l3hr1EnUGY \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"{
"api": "https: //api.sb/ leaseline.app",
"startup": {
"$id": "https: //api.sb/ leaseline.app/ startups/ startup_l3hr1EnUGY",
"$type": "Startup",
"name": "Leaseline"
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Startup.delete",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}