Skip to content

Sequence routes: update, delete

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

Reference for Sequence, one group of Sequence routes.

Sequence.update

Changes the given properties of a Sequence. Verb page.

Text
PATCH /{namespace}/sequences/{id}

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

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Sequence.
stepsjsonThe steps, waits, and branches.
exitOnstringThe Events that end it from any step, such as a reply or a purchase.

Returns

OutputTypeRequiredDescription
sequenceSequencerequiredThe Sequence.

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/sequences/sequence_H7knHGrBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"steps":{}}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "sequence": {
    "$id": "https://api.sb/leaseline.app/sequences/sequence_H7knHGrBdP",
    "$type": "Sequence",
    "steps": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Sequence.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Sequence.delete

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

Text
DELETE /{namespace}/sequences/{id}

Path: id. Emits Sequence.deleted.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Sequence.

Returns

OutputTypeRequiredDescription
sequenceSequencerequiredThe Sequence.

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/sequences/sequence_H7knHGrBdP \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "sequence": {
    "$id": "https://api.sb/leaseline.app/sequences/sequence_H7knHGrBdP",
    "$type": "Sequence",
    "steps": {}
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Sequence.delete",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}