v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Groups

Reject group join requests

Rejects one or more pending join requests for a WhatsApp group.

post/whatsapp/{businessPhoneNumber}/groups/{groupId}/joinRequests/reject

Path parameters

businessPhoneNumberstring required
Example:+16315551111

The WhatsApp business phone number in E.164 format.

groupIdstring required
Example:120363345678901234@g.us

WhatsApp group ID.

Request body

joinRequestsstring[] required

Join request IDs to approve or reject.

Example request

{
  "joinRequests": [
    "join-request-id"
  ]
}

Response

Successfully processed the join request rejection.

approvedJoinRequestsstring[]

Approved join request IDs.

rejectedJoinRequestsstring[]

Rejected join request IDs.

errorsobject[]

Errors returned by WhatsApp.

Example response

{
  "failedJoinRequests": [
    {
      "joinRequestId": "join-request-id"
    }
  ]
}