Sign inGet Started

Reject WhatsApp group join requests

POST
/v1/whatsapp/groups/{group_id}/join-requests/batch-reject
const result = await bird.whatsapp.groups.joinRequests.reject(
  "wag_01krdgeqcxet5s7t44vh8rt9mg",
  { join_request_ids: ["wgj_01krdgeqcxet5s7t44vh8rt9mg"] },
);
for (const failure of result.failed) {
  console.log(failure.join_request_id, failure.error.description);
}
响应202
{
  "decided": [
    "wgj_01krdgeqcxet5s7t44vh8rt9mg"
  ],
  "failed": [
    {
      "join_request_id": "wgj_01krdgeqcxet5s7t44vh8rt9mg",
      "error": {
        "description": "Group subject contains content that cannot be used.",
        "meta_error_code": "2388024"
      }
    }
  ]
}

Rejects the named join requests, up to 50 in one call.

WhatsApp decides each request on its own, so the batch can be part-applied: the response lists the ones it accepted in decided and the rest in failed with the reason each was refused. A refusal is usually a person who has not accepted WhatsApp's current terms, which no retry fixes.

A group that is not active refuses the whole call, with a 409 WhatsAppGroupNotActive, rather than returning per-request failures.

Each person rejected sees the option to ask again the next time they open the invite link, so a rejection is not a ban. Remove someone through the participants operation if they should not be able to come back.

参数

group_idstring

ID of the group whose join requests are being decided.

请求载荷

join_request_ids
array of string
必填

The join requests to act on, as returned by GET /v1/whatsapp/groups/{group_id}/join-requests. Each is decided on its own, so one can fail while the rest succeed. An ID that names no waiting request returns a 422 WhatsAppGroupJoinRequestNotFound. The 50 is Bird's own request bound, not a WhatsApp one: how many people the group can hold does not limit how many can queue at its link, so a rejection sweep is not held to the size of the group it is refusing entry to.

响应载荷

decided
array of string
必填

The join requests WhatsApp accepted the decision for. A person approved here can enter the group; a person rejected here sees the join button again.

failed
array of object
必填

The join requests WhatsApp refused, each with its reason. Empty when the whole batch was applied.

显示子属性