Skip to content

Patch Watch

PATCH
/api/watches/{watch_id}
curl --request PATCH \
--url http://localhost:8000/api/watches/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "config": {}, "enabled": true, "interval": "example", "lead_id": 1, "signal_types": [ "example" ] }'
watch_id
required
Watch Id
string
x-workspace-id
Any of:
string
Media typeapplication/json
WatchPatch
object
config
Any of:
object
key
additional properties
any
enabled
Any of:
boolean
interval
Any of:
string
lead_id
Any of:
integer
signal_types
Any of:
Array<string>
Examplegenerated
{
"config": {},
"enabled": true,
"interval": "example",
"lead_id": 1,
"signal_types": [
"example"
]
}

Successful Response

Media typeapplication/json
Examplegenerated
example

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}