Commands

Update Command

Updates a command.

POST
/commands.update

Updates a command.

Authorization

auth-token

AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

Request Body

application/json

action?
description?string

Description of the command.

Formattext
display_name?string

Display name of the command.

Formattext
id*string

The ID of the command to update.

Formatid
name?string

Name of the command.

Formattext
namespace?string

Namespace of the command.

Formattext
shared_with?

The list of users, groups and audiences with whom the command is shared.

source?string

ID of the source which created this command.

Formatid
status?string

Status of the command.

Value in"disabled" | "draft" | "enabled"
surfaces?

Surfaces where this command can be invoked.

usage_hint?string

A user friendly description of the parameters which can be passed to the command.

Formattext

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://api.devrev.ai/commands.update" \  -H "Content-Type: application/json" \  -d '{    "id": "string"  }'
{
  "command": {
    "created_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "created_date": "2023-01-01T12:00:00.000Z",
    "display_id": "string",
    "id": "string",
    "modified_by": {
      "type": "dev_user",
      "display_id": "string",
      "id": "string",
      "display_name": "string",
      "display_picture": {
        "display_id": "string",
        "id": "string",
        "file": {
          "type": "string",
          "name": "string",
          "size": 0
        }
      },
      "email": "string",
      "full_name": "string",
      "state": "active"
    },
    "modified_date": "2023-01-01T12:00:00.000Z",
    "action": {
      "code": "string",
      "executor_type": "rego",
      "message": "string"
    },
    "description": "string",
    "display_name": "string",
    "name": "string",
    "namespace": "string",
    "shared_with": [
      {
        "member": {
          "type": "dev_user",
          "display_id": "string",
          "id": "string",
          "display_name": "string",
          "display_picture": {
            "display_id": "string",
            "id": "string",
            "file": {
              "type": "string",
              "name": "string",
              "size": 0
            }
          },
          "email": "string",
          "full_name": "string",
          "state": "active"
        },
        "role": {
          "display_id": "string",
          "id": "string",
          "sync_metadata": {
            "external_reference": "string",
            "origin_system": "string"
          }
        }
      }
    ],
    "source": {
      "display_id": "string",
      "id": "string"
    },
    "status": "disabled",
    "surfaces": [
      {
        "object_types": [
          "account"
        ],
        "surface": "customer_chat"
      }
    ],
    "usage_hint": "string"
  }
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "not_found"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}