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
chevron-right
200

Groups retrieved successfully

application/json
objectOptional
get
/groups

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
stringOptional
Responses
chevron-right
200

Group created successfully

application/json
objectOptional
post
/groups

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

Responses
chevron-right
200

Group information retrieved successfully

application/json
objectOptional
get
/groups/{group_id}

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
stringOptional
Responses
chevron-right
200

Group updated successfully

application/json
objectOptional
post
/groups/{group_id}

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
chevron-right
200

Group deleted successfully

application/json
objectOptional
delete
/groups/{group_id}
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
chevron-right
200

Invite link retrieved successfully

application/json
objectOptional
get
/groups/{group_id}/invite_link

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
objectOptional
Responses
chevron-right
200

Invite link reset successfully

application/json
objectOptional
post
/groups/{group_id}/invite_link

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
chevron-right
200

Join requests retrieved successfully

application/json
objectOptional
get
/groups/{group_id}/join_requests

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

Bodystring[]
string[]Optional
Responses
chevron-right
200

Join requests approved successfully

application/json
objectOptional
post
/groups/{group_id}/join_requests

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

Bodystring[]
string[]Optional
Responses
chevron-right
200

Join requests rejected successfully

application/json
objectOptional
delete
/groups/{group_id}/join_requests

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
stringOptional
Responses
chevron-right
200

Participants removed successfully

application/json
objectOptional
delete
/groups/{group_id}/participants

Last updated

Was this helpful?