Skip to content
Reference/Broadcast Groups/Create Broadcast Group

Create Broadcast Group

POSThttps://public.leadpattern.com/groups
Plan: broadcastapplication/json60 req/min

Create a new broadcast group and optionally seed it with members. Groups are used to send template messages to multiple contacts at once.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Body Parameters

2 fields
namestring
required
Group name.
membersarray of objects
optional
Initial members to add.
phonestring
required
Member phone number (with country code).
namestring
optional
Member display name.

Responses

JSON Response
{
  "type": "success",
  "data": {
    "groupData": {
      "groupId": "664abc123def456789012345",
      "memberCount": 2,
      "groupChatName": "VIP Customers"
    },
    "invalidMembers": []
  }
}

Sample Request Body

{
  "name": "VIP Customers",
  "members": [
    {
      "phone": "919999999999",
      "name": "John Doe"
    },
    {
      "phone": "918888888888",
      "name": "Jane Smith"
    }
  ]
}