CreatePlacementRule

POST

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

Creates a placement rule for org sending the request with the provided parameters.
The @placement_rule_sid of the new entity will be returned in the response.
The @schedule_scenario_sid must match the scenario of the parent shift template.
The @member fields will be ignored since those cannot be created by this method and must be created by their respective create methods.
Errors:

grpc.Invalid: the parameters in the @placement_rule are invalid.

grpc.NotFound: the parent shift template doesn't exist or belongs to a different scenario than the one given.
the scheduling activity to associate with the placement rule doesn't exist or belongs to a different scenario than the one given.

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

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "placement_rule": {
        "placement_rule_sid": 0,
        "shift_template_sid": 0,
        "activity_order": 0,
        "min_duration_minutes": 0,
        "max_duration_minutes": 0,
        "scheduling_activity_sid": 0,
        "schedule_scenario_sid": 0,
        "member_scheduling_activity": {
            "scheduling_activity_sid": 0,
            "is_skill_activity": true,
            "activity_sid": "string",
            "member_non_skill_activity": {
                "non_skill_activity_sid": 0,
                "name": "string",
                "description": "string",
                "datetime_set_to_inactive": "1s",
                "red": 0,
                "green": 0,
                "blue": 0,
                "transparency": 0,
                "inherited_from_entity": {
                    "parent_sid": 0,
                    "parent_type": "CALL_CENTER_NODE"
                }
            },
            "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
            "pause_codes": [
                "string"
            ],
            "reason_codes": [
                {
                    "reason_code_id": 0,
                    "name": "string",
                    "scheduling_activity_sid": 0,
                    "is_planned": true,
                    "is_paid": true,
                    "is_default": true,
                    "datetime_set_to_inactive": "1s"
                }
            ]
        }
    }
}

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/createplacementrule' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "placement_rule": {
        "placement_rule_sid": 0,
        "shift_template_sid": 0,
        "activity_order": 0,
        "min_duration_minutes": 0,
        "max_duration_minutes": 0,
        "scheduling_activity_sid": 0,
        "schedule_scenario_sid": 0,
        "member_scheduling_activity": {
            "scheduling_activity_sid": 0,
            "is_skill_activity": true,
            "activity_sid": "string",
            "member_non_skill_activity": {
                "non_skill_activity_sid": 0,
                "name": "string",
                "description": "string",
                "datetime_set_to_inactive": "1s",
                "red": 0,
                "green": 0,
                "blue": 0,
                "transparency": 0,
                "inherited_from_entity": {
                    "parent_sid": 0,
                    "parent_type": "CALL_CENTER_NODE"
                }
            },
            "activity_classification": "STANDARD_SCHEDULING_ACTIVITY",
            "pause_codes": [
                "string"
            ],
            "reason_codes": [
                {
                    "reason_code_id": 0,
                    "name": "string",
                    "scheduling_activity_sid": 0,
                    "is_planned": true,
                    "is_paid": true,
                    "is_default": true,
                    "datetime_set_to_inactive": "1s"
                }
            ]
        }
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "placement_rule_sid": 0
}

🟢200Success

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

BuildShiftTemplateDiagnostics

UpdatePlacementRule