GetContactPreferences

GetContactPreferences returns preferences for contact lists.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request for the GetContactPreferences RPC.

field_mask

string

field_mask

optional

Field mask for filtering each field.

Example

{
    "field_mask": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Body

Response for the GetContactPreferences RPC.

contact_preferences

object (ContactPreferences)

contact_preferences

optional

Contact preferences entity.

default_contact_import_format

optional

Default import format, either custom of standardized.

default_contact_area_code

optional

Default area code, either custom or predefined field.

default_duplicate_handling

enum<string>

default_duplicate_handling

optional

How duplicate contact numbers are handled by default.

Allowed values:

DEFAULT_DUPLICATE_HANDLING_KEEP_RECORD_AND_DISCARD_NUMBERDEFAULT_DUPLICATE_HANDLING_DISCARD_RECORDDEFAULT_DUPLICATE_HANDLING_ALLOW_DUPLICATESDEFAULT_DUPLICATE_HANDLING_CREATE_DUPLICATES_LIST

org_id

string

org_id

optional

Org ID.

use_contact_import_format

boolean

use_contact_import_format

optional

Whether the selected contact import format preference is used.

use_contact_area_code

boolean

use_contact_area_code

optional

Whether the contact area code is enabled.

discard_record_default_absent_numbers_handling

boolean

discard_record_default_absent_numbers_handling

optional

Default absent numbers handling; false to keep (default) or true to
discard recording.

default_contacts_import_randomization

boolean

default_contacts_import_randomization

optional

Whether contacts import randomization is enabled.

default_email_column

string

default_email_column

optional

The contact field to use as the default in emails.

Example

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

🔴500Server Error