Update Command

POST

Updates a command.

Request

This endpoint expects an object.

actionobjectRequired

idstringRequiredformat: "id"

The ID of the command to update.

statusenumRequired

Allowed values: disableddraftenabled

Status of the command.

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.

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

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           "sync_metadata": {
68             "external_reference": "external_reference",
69             "origin_system": "origin_system"
70           },
71           "display_id": "display_id"
72         }
73       },
74       {
75         "member": {
76           "type": "dev_user",
77           "display_picture": {
78             "file": {
79               "type": "type",
80               "name": "name"
81             },
82             "id": "id",
83             "display_id": "display_id"
84           },
85           "id": "id",
86           "state": "active",
87           "display_id": "display_id",
88           "display_name": "display_name",
89           "email": "email",
90           "full_name": "full_name"
91         },
92         "role": {
93           "id": "id",
94           "sync_metadata": {
95             "external_reference": "external_reference",
96             "origin_system": "origin_system"
97           },
98           "display_id": "display_id"
99         }
100       }
101     ],
102     "surfaces": [
103       {
104         "surface": "customer_chat",
105         "object_types": [
106           "account",
107           "account"
108         ]
109       },
110       {
111         "surface": "customer_chat",
112         "object_types": [
113           "account",
114           "account"
115         ]
116       }
117     ],
118     "usage_hint": "usage_hint"
119   }
120 }

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	"sync_metadata": {
68	"external_reference": "external_reference",
69	"origin_system": "origin_system"
70	},
71	"display_id": "display_id"
72	}
73	},
74	{
75	"member": {
76	"type": "dev_user",
77	"display_picture": {
78	"file": {
79	"type": "type",
80	"name": "name"
81	},
82	"id": "id",
83	"display_id": "display_id"
84	},
85	"id": "id",
86	"state": "active",
87	"display_id": "display_id",
88	"display_name": "display_name",
89	"email": "email",
90	"full_name": "full_name"
91	},
92	"role": {
93	"id": "id",
94	"sync_metadata": {
95	"external_reference": "external_reference",
96	"origin_system": "origin_system"
97	},
98	"display_id": "display_id"
99	}
100	}
101	],
102	"surfaces": [
103	{
104	"surface": "customer_chat",
105	"object_types": [
106	"account",
107	"account"
108	]
109	},
110	{
111	"surface": "customer_chat",
112	"object_types": [
113	"account",
114	"account"
115	]
116	}
117	],
118	"usage_hint": "usage_hint"
119	}
120	}