GetContactPreferences

POST

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

GetContactPreferences returns preferences for contact lists.

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

Responses

🟢200OK

application/json

Success

Body

Example

{
    "contact_preferences": {
        "org_id": "string",
        "default_contact_import_format": {
            "custom": {
                "id": 0,
                "name": "string"
            }
        },
        "use_contact_import_format": true,
        "default_contact_area_code": {
            "cfd": {
                "id": 0,
                "field_name": "string",
                "is_phone": true,
                "display_format_string": "string"
            }
        },
        "use_contact_area_code": true,
        "discard_record_default_absent_numbers_handling": true,
        "default_contacts_import_randomization": true,
        "default_email_column": "string",
        "default_duplicate_handling": "DEFAULT_DUPLICATE_HANDLING_KEEP_RECORD_AND_DISCARD_NUMBER"
    }
}

🟢200Success

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

UpdateAgentPreferences

UpdateContactPreferences