Create Stage Diagram

POST

Creates a stage diagram.

Request

This endpoint expects an object.

leaf_typestringRequiredformat: "text"

The leaf type this stage diagram applies to.

namestringRequiredformat: "text"

The name of the stage diagram. Stage diagram is used for defining stage transitions.

stageslist of objectsRequired

List of stages in the diagram.

is_custom_leaf_typebooleanOptional

Whether the leaf type corresponds to a custom object.

is_defaultbooleanOptional

Whether this is a default stage diagram.

Response

Success.

stage_diagramobject

POST

1 curl -X POST https://api.devrev.ai/stage-diagrams.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "leaf_type": "leaf_type",
6   "name": "name",
7   "stages": [
8     {
9       "stage_id": "stage_id"
10     },
11     {
12       "stage_id": "stage_id"
13     }
14   ]
15 }'

201Created

1 {
2   "stage_diagram": {
3     "id": "id",
4     "stages": [
5       {
6         "is_deprecated": true,
7         "is_start": true,
8         "stage": {
9           "id": "id",
10           "display_id": "display_id",
11           "name": "name"
12         },
13         "transitions": [
14           {
15             "target_stage": {
16               "id": "id",
17               "name": "name"
18             }
19           },
20           {
21             "target_stage": {
22               "id": "id",
23               "name": "name"
24             }
25           }
26         ]
27       },
28       {
29         "is_deprecated": true,
30         "is_start": true,
31         "stage": {
32           "id": "id",
33           "display_id": "display_id",
34           "name": "name"
35         },
36         "transitions": [
37           {
38             "target_stage": {
39               "id": "id",
40               "name": "name"
41             }
42           },
43           {
44             "target_stage": {
45               "id": "id",
46               "name": "name"
47             }
48           }
49         ]
50       }
51     ],
52     "created_by": {
53       "type": "dev_user",
54       "id": "id",
55       "display_id": "display_id",
56       "display_name": "display_name",
57       "display_picture": {
58         "id": "id",
59         "display_id": "display_id",
60         "file": {}
61       },
62       "email": "email",
63       "full_name": "full_name",
64       "state": "active"
65     },
66     "created_date": "created_date",
67     "display_id": "display_id",
68     "is_custom_leaf_type": true,
69     "is_default": true,
70     "leaf_type": "leaf_type",
71     "modified_by": {
72       "type": "dev_user",
73       "id": "id",
74       "display_id": "display_id",
75       "display_name": "display_name",
76       "display_picture": {
77         "id": "id",
78         "display_id": "display_id",
79         "file": {}
80       },
81       "email": "email",
82       "full_name": "full_name",
83       "state": "active"
84     },
85     "modified_date": "modified_date",
86     "name": "name"
87   }
88 }

Get Stage Diagram

Up Next

Built with

1	curl -X POST https://api.devrev.ai/stage-diagrams.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"leaf_type": "leaf_type",
6	"name": "name",
7	"stages": [
8	{
9	"stage_id": "stage_id"
10	},
11	{
12	"stage_id": "stage_id"
13	}
14	]
15	}'

1	{
2	"stage_diagram": {
3	"id": "id",
4	"stages": [
5	{
6	"is_deprecated": true,
7	"is_start": true,
8	"stage": {
9	"id": "id",
10	"display_id": "display_id",
11	"name": "name"
12	},
13	"transitions": [
14	{
15	"target_stage": {
16	"id": "id",
17	"name": "name"
18	}
19	},
20	{
21	"target_stage": {
22	"id": "id",
23	"name": "name"
24	}
25	}
26	]
27	},
28	{
29	"is_deprecated": true,
30	"is_start": true,
31	"stage": {
32	"id": "id",
33	"display_id": "display_id",
34	"name": "name"
35	},
36	"transitions": [
37	{
38	"target_stage": {
39	"id": "id",
40	"name": "name"
41	}
42	},
43	{
44	"target_stage": {
45	"id": "id",
46	"name": "name"
47	}
48	}
49	]
50	}
51	],
52	"created_by": {
53	"type": "dev_user",
54	"id": "id",
55	"display_id": "display_id",
56	"display_name": "display_name",
57	"display_picture": {
58	"id": "id",
59	"display_id": "display_id",
60	"file": {}
61	},
62	"email": "email",
63	"full_name": "full_name",
64	"state": "active"
65	},
66	"created_date": "created_date",
67	"display_id": "display_id",
68	"is_custom_leaf_type": true,
69	"is_default": true,
70	"leaf_type": "leaf_type",
71	"modified_by": {
72	"type": "dev_user",
73	"id": "id",
74	"display_id": "display_id",
75	"display_name": "display_name",
76	"display_picture": {
77	"id": "id",
78	"display_id": "display_id",
79	"file": {}
80	},
81	"email": "email",
82	"full_name": "full_name",
83	"state": "active"
84	},
85	"modified_date": "modified_date",
86	"name": "name"
87	}
88	}