Skip to content

Update command status

Request

API to update a command status state

Security
apiKey
Path
idstringrequired

ID of the command status object

Bodyapplication/jsonrequired
statestring

Command state to update

Enum:"Command Acknowledged""Command In Progress""Command TimeOut""Command Success""Command Failure""Command Scheduled""Command Cancelled"
reasonstring

State change reason to update

cURL
curl -i -X PUT \
  'https://develop-api.esper.io/_mock/openapi/commands/v0/status/{id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "state": "Command Acknowledged",
    "reason": "string"
  }'

Responses

Command status successfully updated.

Bodyapplication/json
codeinteger
messagestring
contentobject(CommandStatus)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "request": "60448f3a-8291-43df-9526-c3d4a574e4d2",
    "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
    "state": "Command Queued",
    "reason": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}