Skip to main content

Request

Use type as interactive and set interactive.type to list.

Field types

  • to: string (required)
  • type: string = interactive (required)
  • interactive: object (required)
  • interactive.type: string = list (required)
  • interactive.header: object (optional)
  • interactive.header.type: string (optional, usually text)
  • interactive.header.text: string (optional)
  • interactive.body: object (required)
  • interactive.body.text: string (required)
  • interactive.footer: object (optional)
  • interactive.footer.text: string (optional)
  • interactive.action: object (required)
  • interactive.action.button: string (required)
  • interactive.action.sections: array of objects (required)
  • interactive.action.sections[].title: string (required)
  • interactive.action.sections[].rows: array of objects (required)
  • interactive.action.sections[].rows[].id: string (required)
  • interactive.action.sections[].rows[].title: string (required)
  • interactive.action.sections[].rows[].description: string (optional)

Field behavior and limits

  • interactive.action.button is required, max 20 characters.
  • interactive.body.text is required, max 4096 characters.
  • interactive.footer.text is optional, max 60 characters.
  • interactive.header.text is optional, max 60 characters.
  • interactive.action.sections requires at least 1 section and supports up to 10 sections.
  • interactive.action.sections[].title is required, max 24 characters.
  • interactive.action.sections[].rows requires at least 1 row and supports up to 10 total rows across sections.
  • interactive.action.sections[].rows[].id is required, max 200 characters.
  • interactive.action.sections[].rows[].title is required, max 24 characters.
  • interactive.action.sections[].rows[].description is optional, max 72 characters.