v1

latestOpenAPI 3.0.02026-07-14181255304.7 KB
Messages

Send quiz message

Send a quiz message to a WhatsApp Channel.

post/messages/quiz

Request body

tostring required

Use the phone number or Chat ID of the contact/group/channel to which you want to send the message. Use Get groups to get the group ID.

quotedstring

Message ID of the message to be quoted

editstring

Message ID of the message to be edited

titlestring required

Title of quiz

optionsstring[] required

Options of quiz

correct_option_indexinteger required

Zero-based index of the correct quiz option

end_timeinteger

Quiz end timestamp

hide_participant_nameboolean

Hide participant names in quiz results

allow_add_optionboolean

Allow participants to add options

Example request

{
  "to": "1234567891@s.whatsapp.net"
}

Response

Created

sentboolean required

Message sent