Transition Org Schedules

POST

Publishes or archives an organization schedule.

Request

This endpoint expects an object.

idstringRequired

Organization schedule 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

Success.

org_scheduleobject

POST

1 curl -X POST https://api.devrev.ai/org-schedules.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": {
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     "default_weekly_org_schedule": {
19       "key": "value"
20     },
21     "display_id": "display_id",
22     "min_valid_days": 1,
23     "modified_by": {
24       "type": "sys_user",
25       "id": "modified_by",
26       "display_id": "modified_by",
27       "display_name": "modified_by",
28       "display_picture": {
29         "id": "id"
30       },
31       "email": "modified_by",
32       "full_name": "modified_by",
33       "state": "active"
34     },
35     "modified_date": "2023-01-01T12:00:00Z",
36     "name": "name",
37     "org_schedule_fragments": [
38       {
39         "key": "value"
40       }
41     ],
42     "timezone": "timezone",
43     "valid_until": "2023-01-01T12:00:00Z",
44     "weekly_org_schedules": [
45       {
46         "key": "value"
47       }
48     ]
49   }
50 }

Update Org Schedule

Up Next

Built with

1	curl -X POST https://api.devrev.ai/org-schedules.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": {
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	"default_weekly_org_schedule": {
19	"key": "value"
20	},
21	"display_id": "display_id",
22	"min_valid_days": 1,
23	"modified_by": {
24	"type": "sys_user",
25	"id": "modified_by",
26	"display_id": "modified_by",
27	"display_name": "modified_by",
28	"display_picture": {
29	"id": "id"
30	},
31	"email": "modified_by",
32	"full_name": "modified_by",
33	"state": "active"
34	},
35	"modified_date": "2023-01-01T12:00:00Z",
36	"name": "name",
37	"org_schedule_fragments": [
38	{
39	"key": "value"
40	}
41	],
42	"timezone": "timezone",
43	"valid_until": "2023-01-01T12:00:00Z",
44	"weekly_org_schedules": [
45	{
46	"key": "value"
47	}
48	]
49	}
50	}