Skip to content

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.

Text
PATCH /{namespace}/sources/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Source.
acquiredstringOne of owned, wrapped, or recruited.
termstextThe terms the Startup holds the right to use and resell it under.

Returns

OutputTypeRequiredDescription
sourceSourcerequiredThe Source.

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/ratebook.dev/sources/source_DIdhfB6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"acquired":"owned"}'
JSON
{
  "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.

Text
DELETE /{namespace}/sources/{id}

Path: id. Emits Source.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Source.

Returns

OutputTypeRequiredDescription
sourceSourcerequiredThe Source.

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/ratebook.dev/sources/source_DIdhfB6mF5 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "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"
  }
}