Source routes: update, delete
The Source Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.
Reference for Source, one group of Source routes.
Source.update
Changes the given properties of a Source. Verb page.
PATCH /{namespace}/ sources/ {id}Path: id. Body, as JSON: the other inputs. Emits Source.updated.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Source. |
acquired | string | One of owned, wrapped, or recruited. | |
terms | text | The terms the Startup holds the right to use and resell it under. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
source | Source | required | The Source. |
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/ ratebook.dev/ sources/ source_DIdhfB6mF5 \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
-H "Content-Type: application/ json" \
-d '{"acquired": "owned"}'{
"api": "https: //api.sb/ ratebook.dev",
"source": {
"$id": "https: //api.sb/ ratebook.dev/ sources/ source_DIdhfB6mF5",
"$type": "Source",
"acquired": "owned"
},
"action": {
"$id": "https: //api.sb/ ratebook.dev/ actions/ act_M5LgINdysq",
"operation": "Source.update",
"status": "done"
},
"links": {
"self": "https: //api.sb/ ratebook.dev/ actions/ act_M5LgINdysq"
}
}Source.delete
Deletes a Source: a soft delete that keeps its history, undone by Thing.restore. Verb page.
DELETE /{namespace}/ sources/ {id}Path: id. Emits Source.deleted.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Source. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
source | Source | required | The Source. |
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/ ratebook.dev/ sources/ source_DIdhfB6mF5 \
-H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"{
"api": "https: //api.sb/ ratebook.dev",
"source": {
"$id": "https: //api.sb/ ratebook.dev/ sources/ source_DIdhfB6mF5",
"$type": "Source",
"acquired": "owned"
},
"action": {
"$id": "https: //api.sb/ ratebook.dev/ actions/ act_M5LgINdysq",
"operation": "Source.delete",
"status": "done"
},
"links": {
"self": "https: //api.sb/ ratebook.dev/ actions/ act_M5LgINdysq"
}
}