Update Command

POST

Updates a command.

Request

This endpoint expects an object.

actionobjectRequired

idstringRequired

The ID of the command to update.

statusenumRequired

Allowed values: disableddraftenabled

Status of the command.

descriptionstringOptional

Description of the command.

display_namestringOptional

Display name of the command.

namestringOptional

Name of the command.

namespacestringOptional

Namespace of the command.

shared_withlist of objectsOptional

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

sourcestringOptional

ID of the source which created this command.

surfaceslist of objectsOptional

Surfaces where this command can be invoked.

usage_hintstringOptional

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

Response

Success.

commandobject

POST

1 curl -X POST https://api.devrev.ai/commands.update \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "action": {
6     "action_details": {},
7     "template_type": "devrev_v1"
8   },
9   "id": "id",
10   "status": "disabled"
11 }'

200Successful

1 {
2   "command": {
3     "created_by": {
4       "type": "dev_user",
5       "display_picture": {
6         "file": {
7           "type": "type",
8           "name": "name"
9         },
10         "id": "id",
11         "display_id": "display_id"
12       },
13       "id": "id",
14       "state": "active",
15       "display_id": "display_id",
16       "display_name": "display_name",
17       "email": "email",
18       "full_name": "full_name"
19     },
20     "id": "id",
21     "modified_by": {
22       "type": "dev_user",
23       "display_picture": {
24         "file": {
25           "type": "type",
26           "name": "name"
27         },
28         "id": "id",
29         "display_id": "display_id"
30       },
31       "id": "id",
32       "state": "active",
33       "display_id": "display_id",
34       "display_name": "display_name",
35       "email": "email",
36       "full_name": "full_name"
37     },
38     "status": "disabled",
39     "created_date": "created_date",
40     "description": "description",
41     "display_id": "display_id",
42     "display_name": "display_name",
43     "modified_date": "modified_date",
44     "name": "name",
45     "namespace": "namespace",
46     "shared_with": [
47       {
48         "member": {
49           "type": "dev_user",
50           "display_picture": {
51             "file": {
52               "type": "type",
53               "name": "name"
54             },
55             "id": "id",
56             "display_id": "display_id"
57           },
58           "id": "id",
59           "state": "active",
60           "display_id": "display_id",
61           "display_name": "display_name",
62           "email": "email",
63           "full_name": "full_name"
64         },
65         "role": {
66           "id": "id",
67           "display_id": "display_id"
68         }
69       },
70       {
71         "member": {
72           "type": "dev_user",
73           "display_picture": {
74             "file": {
75               "type": "type",
76               "name": "name"
77             },
78             "id": "id",
79             "display_id": "display_id"
80           },
81           "id": "id",
82           "state": "active",
83           "display_id": "display_id",
84           "display_name": "display_name",
85           "email": "email",
86           "full_name": "full_name"
87         },
88         "role": {
89           "id": "id",
90           "display_id": "display_id"
91         }
92       }
93     ],
94     "surfaces": [
95       {
96         "surface": "customer_chat",
97         "object_types": [
98           "account",
99           "account"
100         ]
101       },
102       {
103         "surface": "customer_chat",
104         "object_types": [
105           "account",
106           "account"
107         ]
108       }
109     ],
110     "usage_hint": "usage_hint"
111   }
112 }

Create Content Template

Up Next

Built with

1	curl -X POST https://api.devrev.ai/commands.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"action": {
6	"action_details": {},
7	"template_type": "devrev_v1"
8	},
9	"id": "id",
10	"status": "disabled"
11	}'

1	{
2	"command": {
3	"created_by": {
4	"type": "dev_user",
5	"display_picture": {
6	"file": {
7	"type": "type",
8	"name": "name"
9	},
10	"id": "id",
11	"display_id": "display_id"
12	},
13	"id": "id",
14	"state": "active",
15	"display_id": "display_id",
16	"display_name": "display_name",
17	"email": "email",
18	"full_name": "full_name"
19	},
20	"id": "id",
21	"modified_by": {
22	"type": "dev_user",
23	"display_picture": {
24	"file": {
25	"type": "type",
26	"name": "name"
27	},
28	"id": "id",
29	"display_id": "display_id"
30	},
31	"id": "id",
32	"state": "active",
33	"display_id": "display_id",
34	"display_name": "display_name",
35	"email": "email",
36	"full_name": "full_name"
37	},
38	"status": "disabled",
39	"created_date": "created_date",
40	"description": "description",
41	"display_id": "display_id",
42	"display_name": "display_name",
43	"modified_date": "modified_date",
44	"name": "name",
45	"namespace": "namespace",
46	"shared_with": [
47	{
48	"member": {
49	"type": "dev_user",
50	"display_picture": {
51	"file": {
52	"type": "type",
53	"name": "name"
54	},
55	"id": "id",
56	"display_id": "display_id"
57	},
58	"id": "id",
59	"state": "active",
60	"display_id": "display_id",
61	"display_name": "display_name",
62	"email": "email",
63	"full_name": "full_name"
64	},
65	"role": {
66	"id": "id",
67	"display_id": "display_id"
68	}
69	},
70	{
71	"member": {
72	"type": "dev_user",
73	"display_picture": {
74	"file": {
75	"type": "type",
76	"name": "name"
77	},
78	"id": "id",
79	"display_id": "display_id"
80	},
81	"id": "id",
82	"state": "active",
83	"display_id": "display_id",
84	"display_name": "display_name",
85	"email": "email",
86	"full_name": "full_name"
87	},
88	"role": {
89	"id": "id",
90	"display_id": "display_id"
91	}
92	}
93	],
94	"surfaces": [
95	{
96	"surface": "customer_chat",
97	"object_types": [
98	"account",
99	"account"
100	]
101	},
102	{
103	"surface": "customer_chat",
104	"object_types": [
105	"account",
106	"account"
107	]
108	}
109	],
110	"usage_hint": "usage_hint"
111	}
112	}