PopulateWorkflowFields

POST

https://api.cbf.tcn.com/api/v0alpha/acd/populateworkflowfields

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "client_sid": 0,
    "agent_sid": 0,
    "call_sid": 0,
    "call_type": "INBOUND",
    "scheduled_callback_id": "string",
    "field_definitions": [
        {
            "name": "string",
            "alt_name": "string",
            "display_name": "string",
            "field_type": "VALUE_TYPE_UNKNOWN",
            "validation_type": "VALIDATION_NONE",
            "formats": [
                "string"
            ],
            "invoice_type": "UNSPECIFIED",
            "helper_text": {
                "text": "string"
            },
            "required": true
        }
    ]
}

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/v0alpha/acd/populateworkflowfields' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "client_sid": 0,
    "agent_sid": 0,
    "call_sid": 0,
    "call_type": "INBOUND",
    "scheduled_callback_id": "string",
    "field_definitions": [
        {
            "name": "string",
            "alt_name": "string",
            "display_name": "string",
            "field_type": "VALUE_TYPE_UNKNOWN",
            "validation_type": "VALIDATION_NONE",
            "formats": [
                "string"
            ],
            "invoice_type": "UNSPECIFIED",
            "helper_text": {
                "text": "string"
            },
            "required": true
        }
    ]
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "values": {
        "property1": {
            "bool_val": true
        },
        "property2": {
            "bool_val": true
        }
    }
}

🟢200Success

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

FinishSecureFormHandling

ValidateField