whatsapp-groups

Reject WhatsApp group join requests

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.

post/v1/whatsapp/groups/{group_id}/join-requests/batch-reject

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/whatsapp/groups/{group_id}/join-requests/batch-reject
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

group_idstring required
Example:wag_01krdgeqcxet5s7t44vh8rt9mg

ID of the group whose join requests are being decided.

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

join_request_idsWhatsAppGroupJoinRequestID[] required

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.

Example request

{
  "join_request_ids": [
    "wgj_01krdgeqcxet5s7t44vh8rt9mg"
  ]
}

Response

What happened to each join request in the batch.

decidedWhatsAppGroupJoinRequestID[] required

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.

Example response

{
  "decided": [
    "wgj_01krdgeqcxet5s7t44vh8rt9mg"
  ],
  "failed": [
    {
      "join_request_id": "wgj_01krdgeqcxet5s7t44vh8rt9mg",
      "error": {
        "description": "Group subject contains content that cannot be used.",
        "meta_error_code": "2388024"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 2 revisions of this API.