@spec new() :: t()

Creates a new interactive object

@spec put_body(t(), String.t()) :: t()

Sets the body of the Interactive message

@spec put_button_action(t(), [button_title :: String.t()]) :: t()

Adds a list of buttons to the Interactive message

The buttons argument is expected to be a list of strings where each element will be the title (content) of the button.

A max of 3 buttons can be sent.

@spec put_cta_url_action(t(), String.t(), String.t()) :: t()

Adds a CTA URL button to the Interactive message The display_text is the label shown on the button (max 20 characters). The url is the destination URL the user will be redirected to when tapping the button.

This sends a Call-to-Action URL button message.

@spec put_flow_action(t(), String.t(), {:id | :name, String.t()}, map()) :: t()

Sets the message action to a Flow

Note on Flow type messages

As for 2025-07-21 the Whatsapp Cloud API documentation says all fields for Flow messages appear directly on the Action object and this is incorrect as it can be seen on the examples of the same documentation.

This is the example given:

curl -X  POST 'https://graph.facebook.com/v23.0/FROM_PHONE_NUMBER/messages' -H 'Authorization: Bearer ACCESS_TOKEN' -H 'Content-Type: application/json' -d '{
 "messaging_product": "whatsapp",
 "recipient_type": "individual",
 "to": "PHONE_NUMBER",
 "type": "interactive",
 "interactive" : {
  "type": "flow",
  "header": {
    "type": "text",
    "text": "Flow message header"
  },
  "body": {
    "text": "Flow message body"
  },
  "footer": {
    "text": "Flow message footer"
  },
  "action": {
    "name": "flow",
    "parameters": {
      "flow_message_version": "3",
      "flow_id": "<FLOW_ID>", // Or flow_name
      "flow_cta": "Book!",
     }
    }
   }
  }
}'

These fields have to be sent between:

• name: The only thing that appears on the docs about this field is an example with a fixed string "flow"
• parameters: Here is where the flow ID, name and other values have to be sent

@spec put_footer(t(), String.t()) :: t()

Sets the footer of the Interactive message

The footer content cannot be more than 60 characters

@spec put_header(
  t(),
  Wax.Messages.Interactive.Header.type(),
  String.t() | Media.t(),
  String.t() | nil
) ::
  t()

Sets the header of the Interactive message

Adds a list to the Interactive message

The sections argument requires a list of %Section{} structs that can be constructed using the Wax.Messages.Interactive.Section module

@spec put_product_action(t(), String.t(), String.t()) :: t()

Adds a product to the Interactive message

The product ID has to be a valid ID from your catalog only containing digits.

@spec validate(t()) :: :ok | {:error, String.t()}

Validates an Interactive struct