UpdatePlacementRule

POST

https://api.cbf.tcn.com/api/v1alpha/wfm/updateplacementrule

Updates a placement rule corresponding with the given @placement_rule_sid for the org sending the request with the provided parameters.
All of the entity's parameters that are not desired to be updated must be filled with their current values.
The @schedule_scenario_sid must be the original for this placement rule since it cannot be changed.
The @member fields will be ignored since those cannot be updated by this method and must be updated by their respective update methods.
Errors:

grpc.Invalid: the one or more of the fields in the @placement_rule are invalid.

grpc.Internal: error occurs when updating the placement rule.

grpc.NotFound: entry to be updated doesn't exist.
: the parent shift template or related scheduling activity don't exist or belong to a different scenario than the placement rule to update.

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

Responses

🟢200OK

application/json

Success

Body

Example

🔴500Server Error

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

CreatePlacementRule

DeletePlacementRule