Messages

Send interactive flow message

Sends a message with a button that opens a published WhatsApp flow.

Requires an open service window: the recipient must have messaged the business in the last 24 hours. Use POST /messages/template to reach recipients outside that window.

post/messages/interactive/flow

Request body

fromstring required

WhatsApp id of the sender phone number

tostring required

Recipient phone number, digits only, including country code

Response

Message sent successfully

idstring uuid required

Id of the created message

Changes

Changed in 2 of the 9 revisions of this API.2210

    • added the new optional request property interactive/action/parameters/flow_token

      new-optional-request-property

    • added the media type application/json for the response with the status 400

      response-media-type-added

    • added the media type application/json for the response with the status 401

      response-media-type-added

    • added the media type application/json for the response with the status 404

      response-media-type-added

  • 8ccfb9a461e2226See the full diff
    • request body became required

      request-body-became-required

    • the request property interactive/action/parameters/flow_action_payload became not nullable

      request-property-became-not-nullable

    • the request property interactive/footer became not nullable

      request-property-became-not-nullable

    • the request property interactive/header became not nullable

      request-property-became-not-nullable

    • the request property from became required

      request-property-became-required

    • the request property interactive became required

      request-property-became-required

    • the request property interactive/action became required

      request-property-became-required

    • the request property interactive/action/parameters became required

      request-property-became-required

    • the request property interactive/action/parameters/flow_cta became required

      request-property-became-required

    • the request property interactive/action/parameters/flow_name became required

      request-property-became-required

    • the request property interactive/body became required

      request-property-became-required

    • the request property interactive/body/text became required

      request-property-became-required

    • the request property interactive/footer/text became required

      request-property-became-required

    • the request property interactive/header/type became required

      request-property-became-required

    • the request property to became required

      request-property-became-required

    • the name request property const value flow was added

      request-property-const-added

    • the type request property const value flow was added

      request-property-const-added

    • removed the enum value flow of the request property interactive/action/name

      request-property-enum-value-removed

    • removed the enum value flow of the request property interactive/type

      request-property-enum-value-removed

    • the from request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the to request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • the interactive/action/parameters/flow_action_payload request property type/format changed from string/ to object/

      request-property-type-changed

    • the interactive/action/parameters/flow_message_version request property type/format was generalized from integer/ to number/

      request-property-type-generalized

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • the response property id became required for the status 200

      response-property-became-required

    • the id response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ was added for the status 200

      response-property-pattern-added