Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarStartup

Startup routes: claim, clone, hold, import

The Startup Verbs claim, clone, hold, import as api.sb routes, with inputs, result, refusals and an example.

Reference for Startup, one group of Startup routes.

Startup.claim

Claim binds a provisional Startup to a verified owner, which enables payments and every Verb that moves money. Verb page.

Text
POST /{namespace}/startups/{startup}/claim

Path: startup. Body, as JSON: the other inputs. Emits Startup.claimed.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe provisional Startup.
claimTokenstringrequiredThe token issued when the Startup was created.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup, now owned.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.None.
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.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/claim \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"claimToken":"Example claim token"}'
JSON
{
  "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.claim",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Startup.clone

Clone copies a Startup’s definition into a new Startup once, with no link back to the source. Verb page.

Text
POST /{namespace}/startups/{startup}/clone

Path: startup. Body, as JSON: the other inputs. Emits Startup.cloned.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe Startup to copy.
namestringrequiredThe new Startup’s name.

Returns

OutputTypeRequiredDescription
cloneStartuprequiredThe new Startup, in Idea.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.None.
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 POST https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY/clone \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "clone": {
    "$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.clone",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Startup.hold

Hold keeps a Startup running in its current Lifecycle state with no new investment from the Studio. Verb page.

Text
POST /{namespace}/startups/{startup}/hold

Path: startup. Body, as JSON: the other inputs. Emits Startup.held.

Inputs

InputTypeRequiredDescription
startupStartuprequiredThe Startup to hold.
reasontextWhy the Studio holds it.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup, now on Hold.

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.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

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

Startup.import

Import builds a new Startup from an existing business’s definition: its Offers, Pages, Nouns and Processes. Verb page.

Text
POST /{namespace}/startups/import

Body, as JSON: the inputs. Emits Startup.imported.

Inputs

InputTypeRequiredDescription
sourceurlrequiredThe existing business’s site or export.
templateTemplateThe Template to map the definition onto.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe new Startup, in Idea.

Refuses when

CheckErrorFixThen call
The input does not match the schema of the operation.invalid-inputRead the schema of the operation, then send every required field with the right type.None.
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.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/startups/import \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":"https://leaseline.app"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_VBluhMC0sH",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Startup.import",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

launch, sell

Previous

pause, pivot, read, resume

Next