Team routes: update, delete
The Team Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.
Reference for Team, one group of Team routes.
Team.update
Changes the given properties of a Team. Verb page.
PATCH /{namespace}/ teams/ {id}Path: id. Body, as JSON: the other inputs. Emits Team.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Team. |
mission | text | What the Team is for, in one sentence. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
team | Team | required | The Team. |
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/ teams/ team_v8KkFBrXCN \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
-H "Content-Type: application/ json" \
-d '{"mission": "Example mission"}'{
"api": "https: //api.sb/ leaseline.app",
"team": {
"$id": "https: //api.sb/ leaseline.app/ teams/ team_v8KkFBrXCN",
"$type": "Team",
"mission": "Example mission",
"status": "asleep"
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Team.update",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}Team.delete
Deletes a Team: a soft delete that keeps its history, undone by Thing.restore. Verb page.
DELETE /{namespace}/ teams/ {id}Path: id. Emits Team.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Team. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
team | Team | required | The Team. |
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/ teams/ team_v8KkFBrXCN \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"{
"api": "https: //api.sb/ leaseline.app",
"team": {
"$id": "https: //api.sb/ leaseline.app/ teams/ team_v8KkFBrXCN",
"$type": "Team",
"mission": "Example mission",
"status": "asleep"
},
"action": {
"$id": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG",
"operation": "Team.delete",
"status": "done"
},
"links": {
"self": "https: //api.sb/ leaseline.app/ actions/ act_br07HsG8MG"
}
}