Create Command

POST

Creates a command.

Request

This endpoint expects an object.

namestringRequired

Name of the command.

namespacestringRequired

Namespace of the command.

actionobjectOptional

descriptionstringOptional

Description of the command.

display_namestringOptional

Display name 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.

statusenumOptional

Allowed values: disableddraftenabled

Status of the 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.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "name": "name",
6   "namespace": "namespace"
7 }'

200Successful

1 {
2   "command": {
3     "id": "id",
4     "created_by": {
5       "type": "sys_user",
6       "id": "created_by",
7       "display_id": "created_by",
8       "display_name": "created_by",
9       "display_picture": {
10         "id": "id"
11       },
12       "email": "created_by",
13       "full_name": "created_by",
14       "state": "active"
15     },
16     "created_date": "2023-01-01T12:00:00Z",
17     "description": "description",
18     "display_id": "display_id",
19     "display_name": "display_name",
20     "modified_by": {
21       "type": "sys_user",
22       "id": "modified_by",
23       "display_id": "modified_by",
24       "display_name": "modified_by",
25       "display_picture": {
26         "id": "id"
27       },
28       "email": "modified_by",
29       "full_name": "modified_by",
30       "state": "active"
31     },
32     "modified_date": "2023-01-01T12:00:00Z",
33     "name": "name",
34     "namespace": "namespace",
35     "shared_with": [
36       {}
37     ],
38     "status": "disabled",
39     "surfaces": [
40       {}
41     ],
42     "usage_hint": "usage_hint"
43   }
44 }

Built with

1	curl -X POST https://api.devrev.ai/commands.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "name",
6	"namespace": "namespace"
7	}'

1	{
2	"command": {
3	"id": "id",
4	"created_by": {
5	"type": "sys_user",
6	"id": "created_by",
7	"display_id": "created_by",
8	"display_name": "created_by",
9	"display_picture": {
10	"id": "id"
11	},
12	"email": "created_by",
13	"full_name": "created_by",
14	"state": "active"
15	},
16	"created_date": "2023-01-01T12:00:00Z",
17	"description": "description",
18	"display_id": "display_id",
19	"display_name": "display_name",
20	"modified_by": {
21	"type": "sys_user",
22	"id": "modified_by",
23	"display_id": "modified_by",
24	"display_name": "modified_by",
25	"display_picture": {
26	"id": "id"
27	},
28	"email": "modified_by",
29	"full_name": "modified_by",
30	"state": "active"
31	},
32	"modified_date": "2023-01-01T12:00:00Z",
33	"name": "name",
34	"namespace": "namespace",
35	"shared_with": [
36	{}
37	],
38	"status": "disabled",
39	"surfaces": [
40	{}
41	],
42	"usage_hint": "usage_hint"
43	}
44	}