Get Group Invite Link

Get the group's shareable invite link (cached once known). Anyone with the link can join — immediately when joinApprovalMode is off, or after approval when it's on.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
  • Groups are only supported on WHATSAPP_OFFICIAL channels whose number is an Official Business Account (OBA); ineligible numbers receive 422.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
Responses

401

Unauthorized

403

Forbidden — role not permitted

404

Group not found in your organisation

422

Channel not eligible for groups

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json