Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

Update a WhatsApp group

PATCH
/v1/whatsapp/groups/{group_id}
const group = await bird.whatsapp.groups.update("wag_01krdgeqcxet5s7t44vh8rt9mg", {
  subject: "Norwood Fleet — Wednesday route",
});
console.log(group.last_operation?.status); // pending until WhatsApp reports back
Antwort202
{
  "id": "wag_01krdgeqcxet5s7t44vh8rt9mg",
  "whatsapp_number_id": "wan_01krdgeqcxet5s7t44vh8rt9mg",
  "waba": "102290129340398",
  "subject": "New Purchase Inquiry",
  "description": "Jim would like to learn about new car purchase options for current year models.",
  "status": "active",
  "join_approval_mode": "auto_approve",
  "invite_link": "https://chat.whatsapp.com/JZm4S9tCkQx2LpVr7Ny8Ab",
  "participants": [
    {
      "bsuid": "US.1566655121691972",
      "phone_number": "+16505551234",
      "username": "john.doe",
      "last_operation": {
        "type": "settings_update",
        "status": "pending",
        "requested_at": "2026-08-27T14:02:11Z",
        "settled_at": "2026-08-27T14:02:14Z",
        "results": [
          {
            "field": "subject",
            "applied": false,
            "error": {
              "description": "Group subject contains content that cannot be used.",
              "meta_error_code": "2388024"
            }
          }
        ],
        "last_error": {
          "description": "Group subject contains content that cannot be used.",
          "meta_error_code": "2388024"
        }
      }
    }
  ],
  "participant_count": 6,
  "pinned_messages": [
    {
      "message_id": "wam_01krdgeqcxet5s7t44vh8rt9mg",
      "pinned_until": "2026-09-01T09:14:52Z"
    }
  ],
  "profile_picture_url": "https://media.example.com/whatsapp/groups/JZm4S9tCkQx2.jpg",
  "last_operation": {
    "type": "settings_update",
    "status": "pending",
    "requested_at": "2026-08-27T14:02:11Z",
    "settled_at": "2026-08-27T14:02:14Z",
    "results": [
      {
        "field": "subject",
        "applied": false,
        "error": {
          "description": "Group subject contains content that cannot be used.",
          "meta_error_code": "2388024"
        }
      }
    ],
    "last_error": {
      "description": "Group subject contains content that cannot be used.",
      "meta_error_code": "2388024"
    }
  },
  "suspended_at": "2026-08-20T11:04:00Z",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Changes what participants see at the top of the group: its subject, its description, and its picture. Fields you omit are left as they are; send null to clear the description. A null picture clears the one Bird stores, but WhatsApp offers no way to take a group's photo down, so participants keep seeing the current one until a new picture replaces it.

WhatsApp applies each field separately, so a change can be part-applied: one field refused while the others take effect. The 202 response is the change accepted, not applied: it echoes the group as Bird holds it, with last_operation at pending. WhatsApp reports the outcome on the group_settings_update webhook, which settles last_operation to success or failed and fills its results with one entry per field, so a part-apply says which field was refused and why. Re-read the group to see what took effect.

Two 409s guard this, and status is checked first: a group that is not active returns WhatsAppGroupNotActive, whatever its last_operation says. That matters for a group still being created, which is pending on both counts at once, and the group-level answer is the more useful one, since no change can land until it exists. Once the group is active, a change already outstanding returns WhatsAppGroupUpdateInProgress while last_operation.status is pending.

The picture names a file in your workspace's media library, and WhatsApp takes only a square JPEG. join_approval_mode and the administering number are fixed when the group is created and cannot be changed here.

Parameter

group_idstring

ID of the group to change.

Anfrage-Nutzlast

subject
string

A new name for the group. Participants see the change in the group's chat.

description
nullable string

A new description for the group. Send null to clear it; an empty string is a 422 rather than a second way to clear.

profile_picture_url
nullable string

A new picture for the group, naming a file in your workspace's media library. WhatsApp takes a square JPEG of at least 192 by 192 pixels and up to 5 MB; anything else returns a 422. Sending null clears the picture Bird stores, and an empty string is a 422 rather than a second way to clear it; WhatsApp has no operation for removing a group's photo, so the one participants see stays until another picture replaces it.

Antwort-Payload

id
string
erforderlich

Unique identifier for the group. Accepted by every /v1/whatsapp/groups/{group_id} operation, and as to when sending a message to the group.

whatsapp_number_id
string
erforderlich

The business number that created the group. It is the group's admin and the number every message to the group is sent from. Fixed when the group is created.

waba
nullable string
erforderlich

Meta's identifier for the WhatsApp Business Account recorded when the group was created. This is a historical snapshot, not a live account directory projection. Null for a number we operate on your behalf, whose account is not yours to see.

subject
string
erforderlich

The group's name, shown to participants and to anyone who opens the invite link.

description
nullable string

The group's description, shown alongside the subject. Null when the group has none.

status
string
erforderlich

Where the group stands. A group is messageable only while it is active.

join_approval_mode
string
erforderlich

Whether opening the invite link joins the group outright or raises a join request to approve.

invite_link
nullable string

The link that lets someone join the group, which is the only way in. A group has one link at a time. Null while the group is pending, since WhatsApp issues the link when it confirms the group. Rotating it through POST /v1/whatsapp/groups/{group_id}/invite-link/rotate replaces it, and every link the group had before then stops working.

participants
array of object

Who is in the group, as of the last update WhatsApp sent, and the whole set rather than a page: WhatsApp holds a group to a handful of people, so there is never a page's worth to return. The business number that created the group is its admin and is not listed.

Untergeordnete Attribute anzeigen
participant_count
integer
erforderlich

How many people are in the group, excluding your business.

pinned_messages
array of object

The group's pins, newest first. WhatsApp holds a few at once, and pinning past that unpins the oldest rather than refusing. No entry here is merely requested. An entry stays listed until it is unpinned, so one whose pinned_until has passed is still listed after WhatsApp has taken it off the chat.

Untergeordnete Attribute anzeigen
profile_picture_url
nullable string

Address of the group's picture, as WhatsApp serves it. Null when the group has none.

last_operation
object

The last create, settings change or delete asked of the group. pending while WhatsApp has yet to confirm it, which is what a client shows as in-progress and what refuses the next change to the group. A settings change carries per-field results, since WhatsApp can refuse one field and apply the others. A removal reports on the participant's own entry rather than here, so several can be in flight at once. Pinning is synchronous and reports nothing.

Untergeordnete Attribute anzeigen
suspended_at
string

When WhatsApp suspended the group. Present only while the group is suspended, and gone once WhatsApp lifts the suspension.

created_at
string
erforderlich
updated_at
string
erforderlich

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten