UpsertTourPatternWithMembers

POST

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

Replaces the existing Tour Pattern and members with @tour_pattern for the @tour_pattern.shift_template_sid and the org sending the request.
Returns the newly created Tour Pattern and members with their updated SIDs and Week Pattern Numbers.
Any existing Tour Week Patterns, Tour Shift Instance and Segment Configs, Tour Agent Collections and their WFM Agent SIDs
belonging to @tour_pattern.shift_template_sid will be replaced with the members on the provided @tour_pattern.
At least one Tour Agent Collection and one Tour Week Pattern must be provided in the member fields.
If the tour pattern data or members have issues that prevent them from being persisted, a list of diagnostics will be returned describing the issues that must be resolved.
Errors:

grpc.Invalid: the request data is invalid.

grpc.NotFound: the @tour_pattern.shift_template_sid does not exist.

grpc.Internal: error occurs when upserting the tour pattern or members.

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

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

GetTourPatternDiagnostics

GetTourPattern