POST /chats/{chat_jid}/polls

Create a poll in a chat

Path parameters

  • chat_jid string Required
application/json

Body Required

  • question string Required
  • options array[string] Required
  • multi_answer boolean

Responses

  • 200 application/json

    Poll created successfully

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • data object
      Hide data attributes Show data attributes object
      • message_id string
      • question string
      • options array[string]
  • 400 application/json

    Bad request

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 401 application/json

    Unauthorized

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
  • 500 application/json

    Internal server error

    Hide response attributes Show response attributes object
    • status boolean
    • code integer
    • message string
    • error string
POST /chats/{chat_jid}/polls
curl \
 --request POST 'http://localhost:7001/chats/6281234567890@s.whatsapp.net/polls' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"question":"What's your favorite color?","options":["Red","Blue","Green"],"multi_answer":false}'
Request examples
{
  "question": "What's your favorite color?",
  "options": [
    "Red",
    "Blue",
    "Green"
  ],
  "multi_answer": false
}
Response examples (200)
{
  "code": 200,
  "data": {
    "options": [
      "Red",
      "Blue",
      "Green"
    ],
    "question": "What's your favorite color?",
    "message_id": "3EB0ABC123DEF456789"
  },
  "status": true,
  "message": "Poll created successfully"
}
Response examples (200)
{
  "status": true,
  "code": 200,
  "message": "Poll created successfully",
  "data": {
    "message_id": "3EB0ABC123DEF456789",
    "question": "What's your favorite color?",
    "options": [
      "Red",
      "Blue",
      "Green"
    ]
  }
}
Response examples (400)
{
  "code": 400,
  "error": "Poll must have at least 2 options",
  "status": false,
  "message": "Bad request"
}
Response examples (400)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}
Response examples (401)
{
  "code": 401,
  "error": "Invalid or expired JWT token",
  "status": false,
  "message": "Unauthorized"
}
Response examples (401)
{
  "status": false,
  "code": 401,
  "message": "Unauthorized",
  "error": "Invalid or missing authentication"
}
Response examples (500)
{
  "code": 500,
  "error": "Failed to create poll",
  "status": false,
  "message": "Internal server error"
}
Response examples (500)
{
  "status": false,
  "code": 400,
  "message": "Bad request",
  "error": "Bad request"
}