curl --request POST \
  --url https://api.wppfy.com/group/create \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "name": "Meu Novo Grupo",
  "participants": [
    "5521987905995"
  ]
}
'

{
  "group": {
    "JID": "jid8@g.us",
    "OwnerJID": "1232@s.whatsapp.net",
    "OwnerPN": "<string>",
    "Name": "Support Group",
    "NameSetAt": "2023-11-07T05:31:56Z",
    "NameSetBy": "<string>",
    "NameSetByPN": "<string>",
    "Topic": "<string>",
    "TopicID": "<string>",
    "TopicSetAt": "2023-11-07T05:31:56Z",
    "TopicSetBy": "<string>",
    "TopicSetByPN": "<string>",
    "TopicDeleted": true,
    "IsLocked": true,
    "IsAnnounce": true,
    "AnnounceVersionID": "<string>",
    "IsEphemeral": true,
    "DisappearingTimer": 1,
    "IsIncognito": true,
    "IsParent": true,
    "IsJoinApprovalRequired": true,
    "LinkedParentJID": "<string>",
    "IsDefaultSubGroup": true,
    "DefaultMembershipApprovalMode": "<string>",
    "GroupCreated": "2023-11-07T05:31:56Z",
    "CreatorCountryCode": "<string>",
    "ParticipantVersionID": "<string>",
    "Participants": [
      {
        "JID": "<string>",
        "LID": "<string>",
        "PhoneNumber": "<string>",
        "IsAdmin": true,
        "IsSuperAdmin": true,
        "DisplayName": "<string>",
        "ImagePreview": "<string>",
        "Error": 1,
        "AddRequest": {
          "Code": "<string>",
          "Expiration": "2023-11-07T05:31:56Z"
        },
        "Username": "<string>"
      }
    ],
    "MemberAddMode": "",
    "AddressingMode": "",
    "OwnerCanSendMessage": true,
    "OwnerIsAdmin": true,
    "DefaultSubGroupId": "<string>",
    "invite_link": "<string>",
    "request_participants": "<string>",
    "image_url": "<string>",
    "image_preview_url": "<string>",
    "picture_id": "<string>",
    "picture_preview_id": "<string>",
    "picture_empty_at": "2023-11-07T05:31:56Z",
    "image_checked_at": "2023-11-07T05:31:56Z",
    "image_preview_checked_at": "2023-11-07T05:31:56Z",
    "parent_community": {
      "jid": "<string>",
      "name": "<string>",
      "image_url": "<string>",
      "image_preview_url": "<string>",
      "default_subgroup_jid": "<string>"
    },
    "participant_profiles": [
      {
        "jid": "<string>",
        "pn": "<string>",
        "lid": "<string>",
        "username": "<string>",
        "display_name": "<string>",
        "name": "<string>",
        "image_url": "<string>",
        "image_preview_url": "<string>",
        "picture_id": "<string>",
        "picture_preview_id": "<string>",
        "is_admin": true,
        "is_super_admin": true
      }
    ],
    "ParticipantCount": 1,
    "request_participants_lid": "<string>"
  },
  "failed": [
    "<string>"
  ]
}

{
  "error": "no valid WhatsApp participants",
  "failed": [
    "<string>"
  ]
}

{
  "error": "Failed to create group"
}

Groups and Communities

Create a new group

Creates a group with optional initial participants. WhatsApp includes the creator automatically.

Send participants: [], omit the field or use null to create a group with only the creator. Providing only your own PN/LID has the same effect; there is no need to add the creator manually.

To add other people, provide numbers with country code (digits only) or full PN JIDs, such as 5511999999999@s.whatsapp.net. LID JIDs known to the instance are also accepted. Participants are verified and duplicates/aliases of the creator are removed. A list with invalid invitees and no valid invitee still returns 400; it is not silently converted into an empty group.

The response contains group and failed. Those whose privacy settings prevented them from joining are listed in failed, without the individual invite code: to invite them, call POST /group/updateParticipants with action: add (see Convidar pessoas). After creation, the admin can get the invite at GET /group/invitelink/{groupJID}, using group.JID.

POST

group

create

curl --request POST \
  --url https://api.wppfy.com/group/create \
  --header 'Content-Type: application/json' \
  --header 'token: <api-key>' \
  --data '
{
  "name": "Meu Novo Grupo",
  "participants": [
    "5521987905995"
  ]
}
'

{
  "group": {
    "JID": "jid8@g.us",
    "OwnerJID": "1232@s.whatsapp.net",
    "OwnerPN": "<string>",
    "Name": "Support Group",
    "NameSetAt": "2023-11-07T05:31:56Z",
    "NameSetBy": "<string>",
    "NameSetByPN": "<string>",
    "Topic": "<string>",
    "TopicID": "<string>",
    "TopicSetAt": "2023-11-07T05:31:56Z",
    "TopicSetBy": "<string>",
    "TopicSetByPN": "<string>",
    "TopicDeleted": true,
    "IsLocked": true,
    "IsAnnounce": true,
    "AnnounceVersionID": "<string>",
    "IsEphemeral": true,
    "DisappearingTimer": 1,
    "IsIncognito": true,
    "IsParent": true,
    "IsJoinApprovalRequired": true,
    "LinkedParentJID": "<string>",
    "IsDefaultSubGroup": true,
    "DefaultMembershipApprovalMode": "<string>",
    "GroupCreated": "2023-11-07T05:31:56Z",
    "CreatorCountryCode": "<string>",
    "ParticipantVersionID": "<string>",
    "Participants": [
      {
        "JID": "<string>",
        "LID": "<string>",
        "PhoneNumber": "<string>",
        "IsAdmin": true,
        "IsSuperAdmin": true,
        "DisplayName": "<string>",
        "ImagePreview": "<string>",
        "Error": 1,
        "AddRequest": {
          "Code": "<string>",
          "Expiration": "2023-11-07T05:31:56Z"
        },
        "Username": "<string>"
      }
    ],
    "MemberAddMode": "",
    "AddressingMode": "",
    "OwnerCanSendMessage": true,
    "OwnerIsAdmin": true,
    "DefaultSubGroupId": "<string>",
    "invite_link": "<string>",
    "request_participants": "<string>",
    "image_url": "<string>",
    "image_preview_url": "<string>",
    "picture_id": "<string>",
    "picture_preview_id": "<string>",
    "picture_empty_at": "2023-11-07T05:31:56Z",
    "image_checked_at": "2023-11-07T05:31:56Z",
    "image_preview_checked_at": "2023-11-07T05:31:56Z",
    "parent_community": {
      "jid": "<string>",
      "name": "<string>",
      "image_url": "<string>",
      "image_preview_url": "<string>",
      "default_subgroup_jid": "<string>"
    },
    "participant_profiles": [
      {
        "jid": "<string>",
        "pn": "<string>",
        "lid": "<string>",
        "username": "<string>",
        "display_name": "<string>",
        "name": "<string>",
        "image_url": "<string>",
        "image_preview_url": "<string>",
        "picture_id": "<string>",
        "picture_preview_id": "<string>",
        "is_admin": true,
        "is_super_admin": true
      }
    ],
    "ParticipantCount": 1,
    "request_participants_lid": "<string>"
  },
  "failed": [
    "<string>"
  ]
}

{
  "error": "no valid WhatsApp participants",
  "failed": [
    "<string>"
  ]
}

{
  "error": "Failed to create group"
}

Authorizations

token

string

header

required

Body

application/json

name

string

required

Group name

Required string length: 1 - 100

Example:

"WppFy Group"

participants

string[] | null

Optional initial invitees. Empty, omitted or null creates the group with only the creator, automatically included by WhatsApp.

Number with country code, full PN JID, or LID known to the instance.

Example:

["5521987905995", "5511912345678"]

Response

Group created successfully

group

object

required

Represents a group/collective conversation

Show child attributes

failed

string[]

required

JIDs of those who did not join (invalid number, no WhatsApp or blocked by privacy). Does not include the individual invite code. Empty when everyone joined.

Instance

CRM

Proxy

Profile

Send Message

Async Message

Message Actions and Search

Groups and Communities

Newsletters and Channels

Server-Sent Events (SSE)

Blocklist

Labels

Chats

Contacts

Calls

Chatwoot Integration

Business

Quick Replies

Create a new group

Authorizations

Body

Response