Watch routes: update, delete

Reference for Watch, one group of Watch routes.

Watch.update

Changes the given properties of a Watch. Verb page.

Text

PATCH /{namespace}/watches/{id}

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

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Watch.
`selector`	`string`		The Event selector, such as `Order.placed`.
`url`	`url`		Where deliveries go.
`payload`	`string`		One of `full`, or `thin`: the record as the Action left it, or only its versioned address. The default is full.

Returns

Output	Type	Required	Description
`watch`	Watch	required	The Watch.

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/watches/watch_9o4vCuR17L \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://leaseline.app"}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Watch.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Watch.delete

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