Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
chats
group

Add Participant to Group

This endpoint adds a participant to a group

Note that adding unknown numbers is a spammy action and can result in a ban

Per Meta's policies, a user will be added to a group directly only if they have enabled it in their privacy settings, and they are a member of your phone contacts

For all other cases, this will send an invite to them to join the group

post/chats/{chat_id}/add

Headers

x-phonestring
Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

participantsstring[] required
  • Provide a list of participants to be added to the group (in country_code + number format).
  • Participants will be directly added to the group if they are in your phone contacts and their privacy settings allow it. If not, participants will receive an invite to join the group
force_add_participantsboolean
  • When set to true, all participants will be attempted to be added directly to group.
  • Default false

Example request

{
  "participants": [
    "919537851844"
  ],
  "force_add_participants": true
}

Response

200 OK

object required

The response is an object with is_success value for each participant