Skip to content

LinkedWhatsAppBusinessAccount

Source code in docs_src/capo_socialmessaging/types/linked_whats_app_business_account.py
class LinkedWhatsAppBusinessAccount(TypedDict, closed=True):
    arn: "capo_socialmessaging.types.linked_whats_app_business_account_arn.LinkedWhatsAppBusinessAccountArn"
    """<p>The ARN of the linked WhatsApp Business Account.</p>"""
    id: "capo_socialmessaging.types.linked_whats_app_business_account_id.LinkedWhatsAppBusinessAccountId"
    """<p>The ID of the linked WhatsApp Business Account, formatted as <code>waba-01234567890123456789012345678901</code>.</p>"""
    waba_id: "capo_socialmessaging.types.whats_app_business_account_id.WhatsAppBusinessAccountId"
    """<p>The WhatsApp Business Account ID from meta.</p>"""
    registration_status: (
        "capo_socialmessaging.types.registration_status.RegistrationStatus"
    )
    """<p>The registration status of the linked WhatsApp Business Account.</p>"""
    link_date: "capo_socialmessaging.types.whats_app_business_account_link_date.WhatsAppBusinessAccountLinkDate"
    """<p>The date the WhatsApp Business Account was linked.</p>"""
    waba_name: "capo_socialmessaging.types.whats_app_business_account_name.WhatsAppBusinessAccountName"
    """<p>The name of the linked WhatsApp Business Account.</p>"""
    event_destinations: "capo_socialmessaging.types.whats_app_business_account_event_destinations.WhatsAppBusinessAccountEventDestinations"
    """<p>The event destinations for the linked WhatsApp Business Account.</p>"""
    marketing_messages_onboarding_status: NotRequired[
        "capo_socialmessaging.types.whats_app_business_account_marketing_messages_onboarding_status.WhatsAppBusinessAccountMarketingMessagesOnboardingStatus"
    ]
    """<p>The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.</p>"""
    dataset_id: NotRequired[
        "capo_socialmessaging.types.whats_app_dataset_id.WhatsAppDatasetId"
    ]
    """<p>The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.</p>"""
    phone_numbers: "capo_socialmessaging.types.whats_app_phone_number_summary_list.WhatsAppPhoneNumberSummaryList"
    """<p>The phone numbers associated with the Linked WhatsApp Business Account.</p>"""

arn instance-attribute

The ARN of the linked WhatsApp Business Account.

dataset_id instance-attribute

dataset_id: NotRequired[WhatsAppDatasetId]

The Meta Conversions API dataset ID associated with this WhatsApp Business Account. This value is a numeric string of 10 to 20 digits. This field is not present when no dataset has been created for this account.

event_destinations instance-attribute

The event destinations for the linked WhatsApp Business Account.

id instance-attribute

The ID of the linked WhatsApp Business Account, formatted as waba-01234567890123456789012345678901.

The date the WhatsApp Business Account was linked.

marketing_messages_onboarding_status instance-attribute

marketing_messages_onboarding_status: NotRequired[
    WhatsAppBusinessAccountMarketingMessagesOnboardingStatus
]

The onboarding status for the Marketing Messages API. This value is fetched from Meta and indicates whether the WhatsApp Business Account is onboarded for Meta's Marketing Messages API.

phone_numbers instance-attribute

The phone numbers associated with the Linked WhatsApp Business Account.

registration_status instance-attribute

registration_status: RegistrationStatus

The registration status of the linked WhatsApp Business Account.

waba_id instance-attribute

The WhatsApp Business Account ID from meta.

waba_name instance-attribute

The name of the linked WhatsApp Business Account.