Skip to content

CreateWhatsAppFlowInput

Source code in docs_src/capo_socialmessaging/types/create_whats_app_flow_input.py
class CreateWhatsAppFlowInput(TypedDict, closed=True):
    id: "capo_socialmessaging.types.linked_whats_app_business_account_id.LinkedWhatsAppBusinessAccountId"
    """<p>The ID of the WhatsApp Business Account to associate with this Flow.</p>"""
    flow_name: "capo_socialmessaging.types.meta_flow_name.MetaFlowName"
    """<p>The name of the Flow. Must be unique within the WhatsApp Business Account.</p>"""
    categories: (
        "capo_socialmessaging.types.meta_flow_category_list.MetaFlowCategoryList"
    )
    """<p>The categories that classify the business purpose of the Flow. At least one category is required.</p>"""
    flow_json: NotRequired[
        "capo_socialmessaging.types.meta_flow_json_blob.MetaFlowJsonBlob"
    ]
    """<p>The Flow JSON definition that describes the screens, components, and logic of the Flow. Maximum size is 10 MB.</p>"""
    publish: NotRequired["bool"]
    """<p>Set to <code>true</code> to publish the Flow immediately after creation. Requires a valid <code>flowJson</code> that passes Meta's validation.</p>"""
    clone_flow_id: NotRequired["capo_socialmessaging.types.meta_flow_id.MetaFlowId"]
    """<p>The ID of an existing Flow within the same WhatsApp Business Account to clone.</p>"""
    endpoint_uri: NotRequired[
        "capo_socialmessaging.types.meta_flow_endpoint_uri.MetaFlowEndpointUri"
    ]
    """<p>The HTTPS endpoint that Meta calls for a data exchange Flow.</p>"""

categories instance-attribute

The categories that classify the business purpose of the Flow. At least one category is required.

clone_flow_id instance-attribute

clone_flow_id: NotRequired[MetaFlowId]

The ID of an existing Flow within the same WhatsApp Business Account to clone.

endpoint_uri instance-attribute

endpoint_uri: NotRequired[MetaFlowEndpointUri]

The HTTPS endpoint that Meta calls for a data exchange Flow.

flow_json instance-attribute

flow_json: NotRequired[MetaFlowJsonBlob]

The Flow JSON definition that describes the screens, components, and logic of the Flow. Maximum size is 10 MB.

flow_name instance-attribute

flow_name: MetaFlowName

The name of the Flow. Must be unique within the WhatsApp Business Account.

id instance-attribute

The ID of the WhatsApp Business Account to associate with this Flow.

publish instance-attribute

publish: NotRequired[bool]

Set to true to publish the Flow immediately after creation. Requires a valid flowJson that passes Meta's validation.