GetBroadcastPreferences

POST

https://api.cbf.tcn.com/api/v0alpha/org/preferences/reports/broadcast/get

GetBroadcastPreferences returns all broadcast options for campaign preferences for an org.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

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

Body Params application/jsonRequired

Example

{
    "field_mask": "string"
}

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/org/preferences/reports/broadcast/get' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "field_mask": "string"
}'

Responses

🟢200OK

application/json

Success

Body

Example

{
    "broadcast_preferences": {
        "dial_list_penetration_strategy": true,
        "display_list_penetration_strategy": true,
        "display_follow_the_sun": true,
        "follow_the_sun": true,
        "sequence_terminator_override": true,
        "broadcast_template_ordering": "BY_NAME_ASC",
        "email_from_addresses": [
            "string"
        ],
        "start_time_enabled": true,
        "default_start_time": {
            "hours": 0,
            "minutes": 0,
            "timezone": "TIME_ZONE_AMERICA_PUERTO_RICO"
        },
        "stop_time_enabled": true,
        "default_stop_time": {
            "hours": 0,
            "minutes": 0,
            "timezone": "TIME_ZONE_AMERICA_PUERTO_RICO"
        }
    }
}

🟢200Success

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

UpdateWebhookPreferences

UpdateBroadcastPreferences