whatsapp-groups

Rotate a WhatsApp group's invite link

Issues a new invite link for the group. Every link issued before stops working, so anyone still holding one cannot join. Rotate the link when a link has spread further than you intended, or after removing someone you do not want back.

Rotating is not how you read the current link: the group carries its invite_link, so GET /v1/whatsapp/groups/{group_id} is the read. Only an active group has a link to rotate; any other status returns a 409 WhatsAppGroupNotActive.

Like pinning and unpinning, this answers 200 rather than 202. WhatsApp issues the new link in its own reply and sends no webhook for a rotation, so the link in the response is the rotation itself having happened, not an acknowledgement that it will.

post/v1/whatsapp/groups/{group_id}/invite-link/rotate

Request

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

Path parameters

group_idstring required
Example:wag_01krdgeqcxet5s7t44vh8rt9mg

ID of the group whose invite link is being replaced.

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.

Response

The group's new invite link.

invite_linkstring required

The group's one invite link. Every link the group had before this one stops working.

Example response

{
  "invite_link": "https://chat.whatsapp.com/JZm4S9tCkQx2LpVr7Ny8Ab"
}

Changes

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