Update command status

Updates the state of an individual command status record. Supports only CANCEL. Cancellations are not always guaranteed and depends on the command's exact state.

About Update Command Status

Each CommandStatus record tracks the execution of one command against one device and is created automatically when a command request targets that device. This endpoint lets you override the current lifecycle state directly rather than waiting for the device to report back. It's typically used by internal tooling and integrations that need to reconcile command state (such as cancelling a command stuck in Command Queued) rather than as part of a normal command-issuing workflow.

Key Fields / Request Body

state — the new command state; accepts Command Cancelled

reason — free text explaining why the state was changed

Common Use Cases

Cancelling a command that is stuck in a queued state before it reaches the device

Forcing a command into a terminal state when a device is known to be offline or decommissioned

Best Practices

Use GET /commands/v0/status/{id}/ first to confirm the command's current state before changing it

Always include a reason so the change is auditable in the command history

Prefer letting the device report its own status through the normal command lifecycle; only override manually when necessary

Workflow

Call GET /commands/v0/status/{id}/ to review the command's current state and device

Determine the correct terminal or intermediate state to apply

PUT the new state and reason to this endpoint

Confirm the update by re-fetching the command status record