GetCompliancePreferences

POST

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

Returns all client compliance preferences

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

Responses

🟢200OK

application/json

Success

Body

Example

{
    "compliance_preferences": {
        "display_after_hours_calls": true,
        "after_hours_calls": true,
        "display_natural_compliance": true,
        "use_natural_compliance": true,
        "default_compliance_rule_set": "string",
        "display_cell_phone_scrub": true,
        "cell_phone_scrub": true,
        "display_schedule_rules": true,
        "use_schedule_rules": true,
        "default_schedule_rule": {
            "rule_id": 0,
            "name": "string"
        },
        "do_zip_code_scrub": true,
        "zip_code_scrub": {
            "cfd_sid": 0,
            "field_name": "string"
        },
        "default_email_compliance_list": "string",
        "default_sms_compliance_list": "string"
    }
}

🟢200Success

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

UpdateContactPreferences

UpdateCompliancePreferences