Ctrlk
Get StartedStatus PagePartner Docs
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Groups

Endpoints for managing WhatsApp groups

Get Active Groups

get

Retrieve list of active groups for a business phone number with pagination support.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Query parameters
limitintegerOptional

Number of groups to fetch (1-1024, default 25)

afterstringOptional

Cursor for pagination

beforestringOptional

Cursor for pagination

Responses
200

Groups retrieved successfully

application/json

Response payload containing a paginated list of active groups

get/groups
GET /groups HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": {
    "groups": [
      {
        "created_at": 1678900000,
        "id": "1234567890",
        "subject": "My Group"
      }
    ]
  },
  "paging": {
    "cursors": {
      "after": "def456",
      "before": "abc123"
    },
    "next": "https://graph.facebook.com/VERSION/PHONE_NUMBER_ID/groups?limit=25&after=MTAxNTExOTQ1MjAwNzI5NDE=",
    "previous": "https://graph.facebook.com/VERSION/PHONE_NUMBER_ID/groups?limit=10&before=NDMyNzQyODI3OTQw"
  }
}

Create Group

post

Create a new WhatsApp group with specified subject, description, and join approval mode.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Body

Group creation payload

descriptionstringOptionalExample: A group for friends
join_approval_modestringOptionalExample: approval_required
messaging_productstringOptionalExample: whatsapp
subjectstringOptionalExample: My Group
Responses
200

Group created successfully

application/json

Response payload for a successfully created group

idstringOptionalExample: 1234567890
post/groups
POST /groups HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 130

{
  "description": "A group for friends",
  "join_approval_mode": "approval_required",
  "messaging_product": "whatsapp",
  "subject": "My Group"
}
{
  "id": "1234567890"
}

Get Group Information

get

Retrieve detailed metadata about a specific group including participants and settings.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Query parameters
fieldsstringOptional

Comma-separated list of fields to return. Available fields: https://developers.facebook.com/documentation/business-messaging/whatsapp/groups/reference#available-fields

Responses
200

Group information retrieved successfully

application/json

Response payload containing detailed group metadata

creation_timestampintegerOptionalExample: 1678900000
descriptionstringOptional
idstringOptionalExample: 1234567890
join_approval_modestringOptionalExample: approval_required
messaging_productstringOptionalExample: whatsapp
subjectstringOptionalExample: My Group
suspendedbooleanOptionalExample: false
total_participant_countintegerOptionalExample: 10
get/groups/{group_id}
GET /groups/{group_id} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "creation_timestamp": 1678900000,
  "description": "text",
  "id": "1234567890",
  "join_approval_mode": "approval_required",
  "messaging_product": "whatsapp",
  "participants": [
    {
      "wa_id": "1234567890"
    }
  ],
  "subject": "My Group",
  "suspended": false,
  "total_participant_count": 10
}

Update Group Settings

post

Update group subject, description, and profile picture.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Body

Update group settings payload

descriptionstringOptionalExample: Join our community to discuss the latest timepieces.
messaging_productstringOptionalExample: whatsapp
profile_picture_filestringOptionalExample: /local/path/file.jpg
subjectstringOptionalExample: Watch Enthusiasts
Responses
200

Group updated successfully

application/json

Response payload for a successful group update

successbooleanOptionalExample: true
post/groups/{group_id}
POST /groups/{group_id} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "description": "Join our community to discuss the latest timepieces.",
  "messaging_product": "whatsapp",
  "profile_picture_file": "/local/path/file.jpg",
  "subject": "Watch Enthusiasts"
}
{
  "success": true
}

Delete Group

delete

Delete the group and remove all participants permanently.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Responses
200

Group deleted successfully

application/json

Response payload for successful group deletion

successbooleanOptionalExample: true
delete/groups/{group_id}
DELETE /groups/{group_id} HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "success": true
}

Get Group Invite Link

get

Retrieve the current invite link for a group that allows users to join.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Responses
200

Invite link retrieved successfully

application/json

Response payload containing the group invite link

invite_linkstringOptionalExample: https://chat.whatsapp.com/abc123
messaging_productstringOptionalExample: whatsapp
get/groups/{group_id}/invite_link
GET /groups/{group_id}/invite_link HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "invite_link": "https://chat.whatsapp.com/abc123",
  "messaging_product": "whatsapp"
}

Reset Group Invite Link

post

Reset the invite link for a group, invalidating previous links.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Body

Request body

messaging_productstringOptionalExample: whatsapp
Responses
200

Invite link reset successfully

application/json

Response payload containing the new group invite link

invite_linkstringOptionalExample: https://chat.whatsapp.com/xyz789
messaging_productstringOptionalExample: whatsapp
post/groups/{group_id}/invite_link
POST /groups/{group_id}/invite_link HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "messaging_product": "whatsapp"
}
{
  "invite_link": "https://chat.whatsapp.com/xyz789",
  "messaging_product": "whatsapp"
}

Get Join Requests

get

Retrieve list of pending join requests for a group requiring approval.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Responses
200

Join requests retrieved successfully

application/json

Response payload containing pending group join requests

get/groups/{group_id}/join_requests
GET /groups/{group_id}/join_requests HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "creation_timestamp": 1755548877,
      "join_request_id": "1234567890",
      "wa_id": "1234567890"
    }
  ],
  "paging": {
    "cursors": {
      "after": "def456",
      "before": "abc123"
    },
    "next": "https://graph.facebook.com/VERSION/PHONE_NUMBER_ID/groups?limit=25&after=MTAxNTExOTQ1MjAwNzI5NDE=",
    "previous": "https://graph.facebook.com/VERSION/PHONE_NUMBER_ID/groups?limit=10&before=NDMyNzQyODI3OTQw"
  }
}

Approve Join Requests

post

Approve one or more pending join requests for a group.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Body

Join request approval payload

join_requestsstring[]Optional
messaging_productstringOptionalExample: whatsapp
Responses
200

Join requests approved successfully

application/json

Response payload for join request approval/rejection

approved_join_requestsstring[]Optional
messaging_productstringOptionalExample: whatsapp
rejected_join_requestsstring[]Optional
post/groups/{group_id}/join_requests
POST /groups/{group_id}/join_requests HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "join_requests": [
    "text"
  ],
  "messaging_product": "whatsapp"
}
{
  "approved_join_requests": [
    "text"
  ],
  "errors": [
    {
      "code": 131203,
      "error_data": {
        "details": "Recipient has not accepted our new Terms of Service and Privacy Policy."
      },
      "message": "(#131203) Recipient has not accepted our new Terms of Service and Privacy Policy.",
      "title": "Unable to add participant to group"
    }
  ],
  "failed_join_requests": [
    {
      "errors": [
        {
          "code": 131203,
          "error_data": {
            "details": "Recipient has not accepted our new Terms of Service and Privacy Policy."
          },
          "message": "(#131203) Recipient has not accepted our new Terms of Service and Privacy Policy.",
          "title": "Unable to add participant to group"
        }
      ],
      "join_request_id": "1234567890"
    }
  ],
  "messaging_product": "whatsapp",
  "rejected_join_requests": [
    "text"
  ]
}

Reject Join Requests

delete

Reject one or more pending join requests for a group.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Body

Join request rejection payload

join_requestsstring[]Optional
messaging_productstringOptionalExample: whatsapp
Responses
200

Join requests rejected successfully

application/json

Response payload for join request approval/rejection

approved_join_requestsstring[]Optional
messaging_productstringOptionalExample: whatsapp
rejected_join_requestsstring[]Optional
delete/groups/{group_id}/join_requests
DELETE /groups/{group_id}/join_requests HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "join_requests": [
    "text"
  ],
  "messaging_product": "whatsapp"
}
{
  "approved_join_requests": [
    "text"
  ],
  "errors": [
    {
      "code": 131203,
      "error_data": {
        "details": "Recipient has not accepted our new Terms of Service and Privacy Policy."
      },
      "message": "(#131203) Recipient has not accepted our new Terms of Service and Privacy Policy.",
      "title": "Unable to add participant to group"
    }
  ],
  "failed_join_requests": [
    {
      "errors": [
        {
          "code": 131203,
          "error_data": {
            "details": "Recipient has not accepted our new Terms of Service and Privacy Policy."
          },
          "message": "(#131203) Recipient has not accepted our new Terms of Service and Privacy Policy.",
          "title": "Unable to add participant to group"
        }
      ],
      "join_request_id": "1234567890"
    }
  ],
  "messaging_product": "whatsapp",
  "rejected_join_requests": [
    "text"
  ]
}

Remove Group Participants

delete

Remove one or more participants from a group.

Authorizations
D360-API-KEYstringRequired

API Key for Messaging API authentication. Send your API key in the D360-API-KEY header.

Path parameters
group_idstringRequired

Group ID

Body

Request body

messaging_productstringOptionalExample: whatsapp
Responses
200

Participants removed successfully

application/json

Response payload for successful participant removal

successbooleanOptionalExample: true
delete/groups/{group_id}/participants
DELETE /groups/{group_id}/participants HTTP/1.1
Host: waba-v2.360dialog.io
D360-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "messaging_product": "whatsapp",
  "participants": [
    {
      "user": "1234567890"
    }
  ]
}
{
  "success": true
}
PreviousMedia Uploads
NextCalling

Last updated

Was this helpful?