Documentation

Groups & mentions

List groups, read participants and tag members with real mentions.

EndpointsLive, phone check

Paths are relative to https://api.sendjade.com/api/v1/instances/{id}. Viewers can read; members can change groups and send.

MethodPathPurpose
GET/groupsList groups
GET/groups/{groupId}Group details
GET/groups/{groupId}/participantsMembers with phone, lid and mentionAs
POST/groups{ subject, participants[] } create a group
PATCH/groups/{groupId}{ subject?, description?, announce?, locked? }
POST/groups/{groupId}/participants{ action: add, remove, promote or demote, participants[] }
POST/groups/{groupId}/pictureSet the group picture (multipart)
POST/groups/{groupId}/leaveLeave the group
POST/groups/{groupId}/messages{ text, mentions?[] } send to the group and tag members

Green-style equivalents: createGroup, getGroupData, updateGroupName, updateGroupSettings, addGroupParticipant, removeGroupParticipant, setGroupAdmin, removeAdmin, setGroupPicture, leaveGroup, and sendMessage with mentions.

Real @mentionsLive, phone check

A real mention notifies the person. WhatsApp needs two things to agree: the member's id in a mentionedJid list and @<id> in the text. You pass mentions as a list of phone numbers, ids, or the word "all", and Sendjade does the rest:

  • Each entry is resolved against the group's real member list, using the id the group itself uses for that member.
  • In groups that address members by an internal LID (common with newer WhatsApp versions), the correct LID is used, and the @2348012345678 you typed in the text is rewritten to match.
  • If you list someone but forget the @ in the text, the tag is appended so it is always visible.
  • Anyone who is not a member is rejected with 400 mention_not_in_group, because they would silently be sent as plain text.
  • Mentions only work for groups: otherwise 422 mentions_only_in_groups. "all" tags everyone.
POST /instances/{id}/groups/{groupId}/messages
{
  "text": "@2348012345678 @2348098765432 please review the stock count",
  "mentions": ["2348012345678", "2348098765432"]
}

Groups on Telegram and MAXBeta

  • Telegram: mentions work with an @username or a numeric user id and are sent as real mention entities. A bot can read group info for administrators only, can rename, change permissions, remove, promote, demote and leave, but cannot create groups or add people.
  • MAX: no mentions. Group info, rename and leave are available.
  • GET /instances/{id}/groups lists only the groups that have written to the bot, because bots cannot list their chats.