EndUserMessagingSocial / Client / create_whatsapp_flow

create_whatsapp_flow

EndUserMessagingSocial.Client.create_whatsapp_flow(**kwargs)

Creates a new WhatsApp Flow. Flows enable businesses to create rich, interactive forms and experiences that users can complete without leaving WhatsApp. The Flow is created in DRAFT status. If publish is set to true and a valid flowJson is provided, the Flow is published immediately.

See also: AWS API Documentation

Request Syntax

response = client.create_whatsapp_flow(
    id='string',
    flowName='string',
    categories=[
        'SIGN_UP'|'SIGN_IN'|'APPOINTMENT_BOOKING'|'LEAD_GENERATION'|'SHOPPING'|'CONTACT_US'|'CUSTOMER_SUPPORT'|'SURVEY'|'OTHER',
    ],
    flowJson=b'bytes',
    publish=True|False,
    cloneFlowId='string'
)
Parameters:

  • id (string) –

    [REQUIRED]

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

  • flowName (string) –

    [REQUIRED]

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

  • categories (list) –

    [REQUIRED]

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

    • (string) –

      The category that classifies the business purpose of a WhatsApp Flow.

  • flowJson (bytes) – The Flow JSON definition that describes the screens, components, and logic of the Flow. Maximum size is 10 MB.

  • publish (boolean) – Set to true to publish the Flow immediately after creation. Requires a valid flowJson that passes Meta’s validation.

  • cloneFlowId (string) – The ID of an existing Flow within the same WhatsApp Business Account to clone.

Return type:

dict

Returns:

Response Syntax

{
    'flowId': 'string',
    'validationErrors': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • flowId (string) –

      The unique identifier assigned to the Flow by Meta.

    • validationErrors (list) –

      A list of validation errors returned by Meta, if any. Validation errors must be resolved before the Flow can be published.

      • (string) –

Exceptions

  • EndUserMessagingSocial.Client.exceptions.ValidationException

  • EndUserMessagingSocial.Client.exceptions.AccessDeniedException

  • EndUserMessagingSocial.Client.exceptions.ResourceNotFoundException

  • EndUserMessagingSocial.Client.exceptions.InvalidParametersException

  • EndUserMessagingSocial.Client.exceptions.AccessDeniedByMetaException

  • EndUserMessagingSocial.Client.exceptions.ThrottledRequestException

  • EndUserMessagingSocial.Client.exceptions.InternalServiceException

  • EndUserMessagingSocial.Client.exceptions.DependencyException