Sign inGet Started
Commencer
Guides
Référence API
SDK
CLI
Base de connaissances
Changelog

Unpin a message in a WhatsApp group

DELETE
/v1/whatsapp/groups/{group_id}/pinned-messages/{message_id}
const group = await bird.whatsapp.groups.pins.delete(
  "wag_01krdgeqcxet5s7t44vh8rt9mg",
  "wam_01kya19eknftrs2s6p82asmvnh",
);
console.log(group.pinned_messages?.length);
Réponse200
{
  "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"
}

Takes the message off the top of the group's chat before its pin would have expired. WhatsApp unpins a message on its own once the days you gave have passed, so unpin only to take one down early.

The message has to be one this group carries: a message in another group, or a one-to-one message, returns a 422 WhatsAppMessageNotInGroup. Past the 30 days messages stay readable for, that check can no longer run, so a message holding no pin answers 200 whichever group it belonged to. Only an active group can be changed; any other status returns a 409 WhatsAppGroupNotActive.

Unpinning a message this group carries that is not currently pinned changes nothing and still answers 200, so a repeated call is safe. WhatsApp confirms a successful unpin in its reply rather than on a webhook, so the entry is gone from pinned_messages by the time the response returns.

Paramètres

group_idstring

ID of the group to unpin a message in.

message_idstring

ID of the message to unpin, as returned in the send response's id.

Contenu de la réponse

id
string
obligatoire

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
obligatoire

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
obligatoire

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
obligatoire

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
obligatoire

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

join_approval_mode
string
obligatoire

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.

Afficher les attributs enfants
participant_count
integer
obligatoire

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.

Afficher les attributs enfants
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.

Afficher les attributs enfants
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
obligatoire
updated_at
string
obligatoire

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.

Obtenir un guide d'implémentation