Skip to content

Minimum Success Criteria routes: update, delete

The Minimum Success Criteria Verbs update, delete as api.sb routes, with inputs, result, refusals and an example.

Reference for Minimum Success Criteria, one group of Minimum Success Criteria routes.

MinimumSuccessCriteria.update

Changes the given properties of a Minimum Success Criteria. Verb page.

Text
PATCH /{namespace}/minimum-success-criteria/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Minimum Success Criteria.
objectivetextThe qualitative outcome.
horizonstringOne of day, week, quarter, year, or three-years.
metricMetricThe Metric the number is measured in.
valuenumberThe number to reach.
bydateThe date it must be reached.
fermijsonThe Price, rates and volumes that show the number is reachable.

Returns

OutputTypeRequiredDescription
minimumSuccessCriteriaMinimum Success CriteriarequiredThe Minimum Success Criteria.

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/leaseline.app/minimum-success-criteria/msc_3UF8zdSOyQ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"metric":"metric_GXFHAlK100"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "minimumSuccessCriteria": {
    "$id": "https://api.sb/leaseline.app/minimum-success-criteria/msc_3UF8zdSOyQ",
    "$type": "MinimumSuccessCriteria",
    "objective": "Example objective",
    "metric": "metric_GXFHAlK100",
    "value": 1,
    "by": "2026-10-22"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "MinimumSuccessCriteria.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

MinimumSuccessCriteria.delete

Deletes a Minimum Success Criteria: a soft delete that keeps its history, undone by Thing.restore. Verb page.

Text
DELETE /{namespace}/minimum-success-criteria/{id}

Path: id. Emits MinimumSuccessCriteria.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Minimum Success Criteria.

Returns

OutputTypeRequiredDescription
minimumSuccessCriteriaMinimum Success CriteriarequiredThe Minimum Success Criteria.

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/leaseline.app/minimum-success-criteria/msc_3UF8zdSOyQ \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "minimumSuccessCriteria": {
    "$id": "https://api.sb/leaseline.app/minimum-success-criteria/msc_3UF8zdSOyQ",
    "$type": "MinimumSuccessCriteria",
    "objective": "Example objective",
    "metric": "metric_GXFHAlK100",
    "value": 1,
    "by": "2026-10-22"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "MinimumSuccessCriteria.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}