GetSchedulePreferences

POST

https://api.cbf.tcn.com/api/v1alpha1/org/preferences/schedule/get

GetSchedulePreferences returns preferences for editing campaign scheduling
properties.

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

Responses

🟢200OK

application/json

Success

Body

Example

{
    "schedule_preferences": {
        "org_id": "string",
        "display_schedule_by_time_zone": true,
        "use_schedule_by_time_zone": true,
        "schedule_by_time_zone_scope": "BOTH",
        "display_schedule_as_paused": true,
        "schedule_as_paused": true,
        "default_completion_threshold": 0,
        "display_campaign_linking": true,
        "use_campaign_linking": true,
        "campaign_links": {
            "property1": "string",
            "property2": "string"
        },
        "default_campaign_link_id": "string",
        "resend_cancelled_campaigns": true
    }
}

🟢200Success

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

UpdateBroadcastPreferences

UpdateSchedulePreferences