Worker routes: update, delete

Reference for Worker, one group of Worker routes.

Worker.update

Changes the given properties of a Worker. Verb page.

Text

PATCH /{namespace}/workers/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Worker.
`name`	`string`		The name the Worker goes by in a Startup.
`instructions`	`text`		How the Worker does its work.

Returns

Output	Type	Required	Description
`worker`	Worker	required	The Worker.

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

Terminal

curl -X PATCH https://api.sb/leaseline.app/workers/worker_whZFpOKWIV \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "worker": {
    "$id": "https://api.sb/leaseline.app/workers/worker_whZFpOKWIV",
    "$type": "Worker",
    "name": "Leaseline"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Worker.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Worker.delete

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