API ReferenceCommands

Update Command

Updates a command.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The ID of the command to update.
actionobjectOptional
descriptionstringOptionalformat: "text"
Description of the command.
display_namestringOptionalformat: "text"
Display name of the command.
namestringOptionalformat: "text"
Name of the command.
namespacestringOptionalformat: "text"
Namespace of the command.
shared_withlist of objectsOptional
The list of users, groups and audiences with whom the command is shared.
sourcestringOptionalformat: "id"
ID of the source which created this command.
statusenumOptional
Status of the command.
Allowed values:
surfaceslist of objectsOptional
Surfaces where this command can be invoked.
usage_hintstringOptionalformat: "text"
A user friendly description of the parameters which can be passed to the command.

Response

Success.
commandobject

Errors