Update a command type
const url = 'https://example.com/api/v1/command-types/example';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"description":"example","display_name":"example","params_schema":"example","settle_window_seconds":1,"target_property_type":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://example.com/api/v1/command-types/example \ --header 'Content-Type: application/json' \ --data '{ "description": "example", "display_name": "example", "params_schema": "example", "settle_window_seconds": 1, "target_property_type": "example" }'Patches a custom command type’s label, description, params schema, settle window, or target (a nil field is unchanged; an empty target clears it). The name is fixed at creation. Official types are read-only. Gated by command_type:update.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The command type’s name
The command type’s name
Request Body required
Section titled “Request Body required ”object
A URL to the JSON Schema for this object.
What the command does
A human label
A JSON Schema fragment (replaces wholesale)
The actuation window in seconds
The property this command sets (empty clears it)
Responses
Section titled “ Responses ”OK
object
A URL to the JSON Schema for this object.
The command type’s uuid, the stable form of name
A JSON Schema fragment for the invocation params
How long the device is given to actuate before a mismatch is a failed command
The property this command sets (empty for a fire-and-forget command)
Example
{ "$schema": "/api/v1/schemas/CommandTypeBody.json"}default
Section titled “default ”Error
object
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
object
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{ "$schema": "/api/v1/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}