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

Response payload containing a paginated list of active groups

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

Group created successfully

application/json

Response payload for a successfully created group

idstringOptionalExample: 1234567890
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
Responses
chevron-right
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}

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

Group updated successfully

application/json

Response payload for a successful group update

successbooleanOptionalExample: true
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

Response payload for successful group deletion

successbooleanOptionalExample: true
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

Response payload containing the group invite link

invite_linkstringOptionalExample: https://chat.whatsapp.com/abc123
messaging_productstringOptionalExample: whatsapp
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
or
Responses
chevron-right
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

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

Response payload containing pending group join requests

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

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

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

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

Participants removed successfully

application/json

Response payload for successful participant removal

successbooleanOptionalExample: true
delete
/groups/{group_id}/participants

Last updated

Was this helpful?