zendesk-messaging-client
    Preparing search index...

    Type Alias Referral

    Data representing a referral object when a user is referred to a conversation. See the conversation referrals guide for more details.

    type Referral = {
        code?: string;
        details?: { adId?: string | null; source?: string; type?: string } | null;
    }
    Index

    Properties

    code? details?

    Properties

    code?: string

    The referral’s identifier.

    details?: { adId?: string | null; source?: string; type?: string } | null

    Nested object containing additional information.

    Type declaration

    • { adId?: string | null; source?: string; type?: string }
      • OptionaladId?: string | null

        If the referral came from an ad, this field will be present with the ad’s Id.

      • Optionalsource?: string

        The source of the referral - MESSENGER_CODE, ADS etc…

      • Optionaltype?: string

        The type of referral, typically OPEN-THREAD.

    • null

    Settings

    Member Visibility

    On This Page

    Properties