DeleteTourWeekPatterns

POST

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

Deletes the Tour Week Patterns with the given @tour_week_pattern_sids for the org sending the request.
Any Tour Week Instance or Segment Configs using @tour_week_pattern_sids will be deleted.
Request will error if any @tour_week_pattern_sids are in use by a Tour Agent Collection, as those must be removed first.
Errors:

grpc.Invalid: the request data is invalid.

grpc.FailedPrecondition: a @tour_week_pattern_sid is in use by a Tour Agent Collection.

grpc.Internal: error occurs when deleting the tour week patterns or configs.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Body Params application/json

Request message for the DeleteTourWeekPatterns RPC.

tour_week_pattern_sids

array[integer <int64> | string]

tour_week_pattern_sids

optional

IDs of the tour week patterns to be deleted.
Any member Configs will be deletes as well.
If any Tour Agent Collections are using the @tour_week_pattern_sids, they must be deleted first.

Example

{
    "tour_week_pattern_sids": [
        0
    ]
}

Request 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/deletetourweekpatterns' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tour_week_pattern_sids": [
        0
    ]
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-07-10 17:42:28

ListTourWeekPatterns

CreateTourShiftInstanceConfig