UpdateTourAgentCollection

POST

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

Updates the given @tour_agent_collection matching the @tour_agent_collection_sid for the org sending the request.
The @wfm_agent_sids will be ignored and will not be updated through this endpoint.
Errors:

grpc.Invalid: the request data is invalid.

grpc.AlreadyExists: the first_week_pattern_number for @tour_pattern_sid is already in use by another tour agent collection.

grpc.NotFound: the given @tour_pattern_sid does not exist for the org sending the request.

grpc.Internal: error occurs when updating the entity.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "tour_agent_collection": {
        "tour_agent_collection_sid": 0,
        "tour_pattern_sid": 0,
        "min_agents_to_schedule": 0,
        "max_agents_to_schedule": 0,
        "first_week_pattern_number": 0,
        "name": "string",
        "wfm_agent_sids": [
            0
        ]
    }
}

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/updatetouragentcollection' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "tour_agent_collection": {
        "tour_agent_collection_sid": 0,
        "tour_pattern_sid": 0,
        "min_agents_to_schedule": 0,
        "max_agents_to_schedule": 0,
        "first_week_pattern_number": 0,
        "name": "string",
        "wfm_agent_sids": [
            0
        ]
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{}

🟢200Success

Modified at 2025-09-26 15:44:58

CreateTourAgentCollection

ListTourAgentCollections