CreateReasonCode

POST

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

Creates the given reason code for the org sending the request.
If @reason_code.is_default is true and there is already a default reason code for the @reason_code.scheduling_activity_sid, the existing default reason code must be set to is_default=false first.
Required permissions:
NONE
Errors:

grpc.AlreadyExists: the @reason_code is set to default, but there is already a default reason code for the scheduling activity.

grpc.Internal: error occours when creating the reason code.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "reason_code": {
        "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/createreasoncode' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "reason_code": {
        "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

{
    "reason_code_id": 0
}

🟢200Success

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

ListConfigEntities

UpdateReasonCode