API resource

WhatsApp groups

Group chats run by your number: create them, manage participants and join requests, and hand out invite links. Only numbers connected as Cloud API only (onboarding=api) can run groups.

Create invite link

POST/v1/whatsapp/wa-groups/{groupId}/invite-link

Works on: WhatsApp

Create a new invite link for a WhatsApp group. The previous link is revoked. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

curl -X POST "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890/invite-link?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"

Response 200

{
  "success": true,
  "inviteLink": "string"
}

Reject join requests

DELETE/v1/whatsapp/wa-groups/{groupId}/join-requests

Works on: WhatsApp

Reject pending join requests for a WhatsApp group. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

Body

phoneNumbersstring[]required

Phone numbers to reject

curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890/join-requests?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumbers": [
      "string"
    ]
  }'

Response 200

{
  "success": true,
  "message": "string"
}

List join requests

GET/v1/whatsapp/wa-groups/{groupId}/join-requests

Works on: WhatsApp

List pending join requests for a WhatsApp group (only for groups with approval_required mode). Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

curl "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890/join-requests?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"

Response 200

{
  "success": true,
  "joinRequests": [
    {
      "user": "string",
      "timestamp": 0
    }
  ]
}

Approve join requests

POST/v1/whatsapp/wa-groups/{groupId}/join-requests

Works on: WhatsApp

Approve pending join requests for a WhatsApp group. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

Body

phoneNumbersstring[]required

Phone numbers to approve

curl -X POST "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890/join-requests?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumbers": [
      "string"
    ]
  }'

Response 200

{
  "success": true,
  "message": "string"
}

Remove participants

DELETE/v1/whatsapp/wa-groups/{groupId}/participants

Works on: WhatsApp

Remove participants from a WhatsApp group. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

Body

phoneNumbersstring[]required

Phone numbers to remove

curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890/participants?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumbers": [
      "string"
    ]
  }'

Response 200

{
  "success": true,
  "message": "string"
}

Add participants

POST/v1/whatsapp/wa-groups/{groupId}/participants

Works on: WhatsApp

Add participants to a WhatsApp group. Maximum 8 participants per request. A group holds at most 8 participants in total (a Meta limit), so later requests cannot grow a group past 8. Meta documents groups as invite-only, so people normally join through the group's invite link. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

Body

phoneNumbersstring[]required

Phone numbers in E.164 format (max 8)

curl -X POST "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890/participants?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumbers": [
      "string"
    ]
  }'

Response 200

{
  "success": true,
  "message": "string"
}

Delete group

DELETE/v1/whatsapp/wa-groups/{groupId}

Works on: WhatsApp

Delete a WhatsApp group and remove all participants. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

curl -X DELETE "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"

Response 200

{
  "success": true,
  "message": "string"
}

Get group info

GET/v1/whatsapp/wa-groups/{groupId}

Works on: WhatsApp

Retrieve metadata about a WhatsApp group including subject, description, participants, and settings. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

curl "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"

Response 200

{
  "success": true,
  "group": {
    "id": "string",
    "subject": "string",
    "description": "string",
    "joinApprovalMode": "string",
    "participants": [
      {
        "user": "string",
        "admin": "string"
      }
    ],
    "participantCount": 0,
    "createdAt": 0,
    "isSuspended": true
  }
}

Update group settings

POST/v1/whatsapp/wa-groups/{groupId}

Works on: WhatsApp

Update the subject, description, or join approval mode of a WhatsApp group. Not available on Coexistence numbers. Requires a Cloud API-only number.

Path parameters

groupIdstringrequired

Group ID

Query parameters

accountIdstringrequired

WhatsApp account ID

Body

subjectstring

descriptionstring

joinApprovalModestring

curl -X POST "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups/120363041234567890?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "string"
  }'

Response 200

{
  "success": true,
  "message": "string"
}

List active groups

GET/v1/whatsapp/wa-groups

Works on: WhatsApp

List active WhatsApp group chats for a business phone number. These are actual WhatsApp group conversations on the platform. Not available on Coexistence numbers. Requires a Cloud API-only number.

Query parameters

accountIdstringrequired

WhatsApp account ID

limitinteger

Max groups to return

afterstring

Pagination cursor

curl "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups?accountId=acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W" \
  -H "Authorization: Bearer $CREATOROS_API_KEY"

Response 200

{
  "groups": [
    {
      "id": "string",
      "subject": "string",
      "createdAt": "2026-10-10T00:00:00.000Z"
    }
  ],
  "paging": {
    "cursors": {
      "after": "string",
      "before": "string"
    }
  }
}

Create group

POST/v1/whatsapp/wa-groups

Works on: WhatsApp

Create a new WhatsApp group chat. Returns the group ID and optionally an invite link. Not available on Coexistence numbers. Requires a Cloud API-only number.

Body

accountIdstringrequired

WhatsApp account ID

subjectstringrequired

Group name (max 128 characters)

descriptionstring

Group description (max 2048 characters)

joinApprovalModestring

Whether users need approval to join via invite link

curl -X POST "https://creatoros-production-5658.up.railway.app/v1/whatsapp/wa-groups" \
  -H "Authorization: Bearer $CREATOROS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "accountId": "acc_Wa2Qp7Vz4Ny9Tx1Lm6Rc3Wb8Js5Df0Ga7Ue2Ki4Oq9W",
    "subject": "string"
  }'

Response 200

{
  "success": true,
  "group": {
    "groupId": "120363041234567890",
    "inviteLink": "string"
  }
}

PreviousWhatsApp templates and flows NextBroadcasts and contacts