CreateDraftSchedule

POST

https://api.cbf.tcn.com/api/v1alpha1/wfm/createdraftschedule

Creates a draft schedule for the org sending the request with the provided parameters.
The @draft_schedule_sid of the new entity will be returned in the response.
The @created_at and @last_updated_at fields will be set to the current time and null respectively.
The draft schedule will include the published schedule's shift instances and shift segments.
Errors:

grpc.Invalid: the @name, @description or @scheduling_range are invalid.

grpc.Internal: error occurs when creating the draft schedule.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v1alpha1/wfm/createdraftschedule' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

Modified at 2025-08-14 21:02:57

GetDraftScheduleRequiredCalls

UpdateDraftSchedule