Interface ContactDeets

Options for including contact information export ContactDeets

interface ContactDeets {
    address?: AddressDeets;
    avatar_bytes?: null | string;
    display_name?: null | string;
    dob?: DOBDeets;
    email_addresses?: null | EmailDeets[];
    external_id?: null | string;
    first_name: string;
    id?: null | string;
    known_name?: null | string;
    last_name: string;
    metadata?: null | {
        [key: string]: any | null;
    };
    middle_initial?: null | string;
    object?: null | string;
    phone_numbers?: null | PhoneDeets[];
    short_bio?: null | string;
    title?: null | string;
    user_id?: null | string;
}

Properties

address? avatar_bytes? display_name? dob? email_addresses? external_id? first_name id? known_name? last_name metadata? middle_initial? object? phone_numbers? short_bio? title? user_id?

Properties

Optionaladdress

address?: AddressDeets

Optionalavatar_bytes

avatar_bytes?: null | string

Base64 encoded byte array (PNG format) to upload as an avatar during contact creation.

Optionaldisplay_name

display_name?: null | string

A separate name for any display purposes.

Optionaldob

dob?: DOBDeets

Optionalemail_addresses

email_addresses?: null | EmailDeets[]

A collection of email addresses for the contact

Optionalexternal_id

external_id?: null | string

Contact unique external id

first_name

first_name: string

The contact's first name

Optionalid

id?: null | string

The Contact Id

Optionalknown_name

known_name?: null | string

A separate name that this contact might be known by.

last_name

last_name: string

The contact's last name

Optionalmetadata

metadata?: null | {
    [key: string]: any | null;
}

Contact Metadata

Optionalmiddle_initial

middle_initial?: null | string

The contact's middle initial

Optionalobject

object?: null | string

Optionalphone_numbers

phone_numbers?: null | PhoneDeets[]

The contact's phone number

Optionalshort_bio

short_bio?: null | string

A short biography for the

Optionaltitle

title?: null | string

A title for the contact (e.g. Mr., Mrs., .Ms, etc)

Optionaluser_id

user_id?: null | string

The user id to operate on their behalf (tenants only)

Settings

Member Visibility

On This Page

Properties