GenerateTourWeekPatterns

POST

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

Generates a list of tour week patterns for @target_shift_template_sid and the org sending the request.
Sets the member_tour_week_patterns with a tour week pattern for each of the @num_weeks_in_tour.
Each of the tour week patterns will be set with tour shift instances and segment configs based on
the forecasted call data over the next @num_weeks_in_tour, starting on the next Monday.
The returned data will not be persisted. This method will not effect any existing tour week patterns in the database.
The @tour_week_patterns returned by this method are intended to replace, not append, all currenly existing tour week patterns for @target_shift_template_sid, once persisted.
Errors:

grpc.Invalid: the request data is invalid.

grpc.NotFound: there is no call center node or @shift_template_sid associated with @schedule_scenario_sid.

grpc.Internal: error occurs when generating the tour week patterns.

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/generatetourweekpatterns' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

DeleteTourAgentCollectionWFMAgents

ListValidAgentsForReplacement