Org Schedule Fragments Transition

POST

Changes stage of an organization schedule fragment.

Request

This endpoint expects an object.

idstringRequired

Organization schedule Fragment ID.

statusenumRequired

Allowed values: archiveddraftpublished

Status determines how an item can be used. In ‘draft’ status an item can be edited but can’t be used. When ‘published’ the item can longer be edited but can be used. ‘Archived’ is read-only.

Response

This endpoint returns an object.

org_schedule_fragmentobject

POST

1 curl -X POST https://api.devrev.ai/org-schedule-fragments.transition \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "id": "id",
6   "status": "archived"
7 }'

200Successful

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

Built with

1	curl -X POST https://api.devrev.ai/org-schedule-fragments.transition \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"id": "id",
6	"status": "archived"
7	}'

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