Commands

Update command

Updates state of a command.

post/api/connector/v1/commands/update

Request

  • Base URL: https://api.mews.com
  • URL: https://api.mews.com/api/connector/v1/commands/update
  • Auth: none declared

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

CommandIdstring uuid required

Identifier of the Command to be updated.

State'Pending' | 'Received' | 'Processing' | 'Processed' | 'Cancelled' | 'Error' required

Pending (Created in Mews, but not yet received by the client application.)

Received (Received by the client application.)

Processing (Being processed by the client application.)

Processed (Successfully processed command.)

Cancelled (A command whose execution has been canceled before (or during) processing.)

Error (A command whose execution or processing was terminated by an error.)

Progressnumber double nullable

Progress of the command processing. Only used if the State is Processing, otherwise ignored.

Notesstring nullable

Notes about command execution. Only used if the State is Processed, Cancelled or Error, otherwise ignored.

Response

OK

Unit required

Changes

No recorded changes to this operation across all 17 revisions of this API.