Groups
Invite people to a group
POST
https://api.batzap.com/v1/groups/{jid}/inviteAdds people to a group the best way possible: first directly, and for anyone whose privacy settings block that, it sends the invite link by direct message.
At most 20 numbers per call; duplicates are removed. People who are already members or have no WhatsApp are reported, not messaged.
Invite DMs appear in the inbox like any other message. The response is success: false when at least one number failed.
- Scope
- groups:write
- Rate limit
- Send · 10/min, 300/day
Path parameters
jidstringrequiredGroup JID (...@g.us), URL-encoded.
Body parameters
phone_numbersstring[]required1 to 20 numbers in E.164 format.
messagestringoptionalText sent before the link in the invite DM.
integration_iduuidoptionalWhatsApp number to act from (see List integrations). Filled in automatically when the key is restricted to a single number.
Errors
400Invalid group JID, empty list, more than 20 numbers or a number not in E.164.
Plus the errors every route can return: see Errors.
