---
title: "Add Group"
method: POST
path: "/orgunit/{orgunitId}/groups"
tags: ["Group"]
---

# Add Group

`POST /orgunit/{orgunitId}/groups`

Provisions a new subscriber segmentation group under the designated orgunit.
The endpoint supports three operational group types configured via the request body:

1. SUBSCRIPTION Group: Create by setting both 'info' and 'whatsapp' to false. Used to broadcast SMS/MMS.        
2. INFO Group: Create by setting 'info' to true. Used for info keywords; cannot contain subscribers.        
3. WHATSAPP Group: Create by setting 'whatsapp' to true. Used exclusively for WhatsApp messaging.

## Path parameters

- `orgunitId` string, required

## Request body

- GroupParam
  - `name` string, required — The official descriptive name of the group. Must be unique within the organization unit.
  - `description` string, nullable — An optional text summary providing additional context or organizational details about the group's purpose.
  - `info` boolean — Set to true to establish this as an INFO group used exclusively for information-only keywords. When true, the group cannot maintain subscribers.
  - `whatsapp` boolean — Set to true to establish this as a WHATSAPP group used exclusively for WhatsApp related subscribers.
  - `notificationMobileNos` string[], nullable — An array of mobile phone numbers that will receive notifications regarding inbound messages.
  - `notificationEmails` string[], nullable — An array of administrative email addresses that will receive notifications regarding inbound messages.
  - `chatEnabled` boolean — Enables or disables two-way interactive chat messaging (inbox) for subscribers within this group.
  - `autoReponse` boolean — When set to true, enables automated system responses to be sent back to subscribers based inbound messages.
  - `autoResponseMessage` string, nullable — The text payload delivered to a subscriber as a standard automated fallback response when 'autoReponse' is enabled.
  - `helpMessage` string, nullable — The custom compliance message sent to non-subscribers who text the 'HELP' keyword to your communication code.
  - `stopMessage` string, nullable — The custom compliance confirmation text sent to non-subscribers who opt out by replying with the 'STOP' keyword.
  - `optinMessage` string, nullable — The custom welcome/compliance message delivered to a subscriber immediately after successfully opting into this group.

## Response `201`

Success

- AddGroupResponseExternalApiResponseNew
  - `data` AddGroupResponse
    - `groupId` string, nullable
  - `appCode` string, nullable
  - `message` string, nullable
  - `isError` boolean

## Other responses

- `400` — Bad Request
- `403` — Forbidden

---

[API](https://skmtc.net/ministrybytext/apis/pbt-api-documentation.md) · [All operations](https://skmtc.net/ministrybytext/apis/pbt-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ministrybytext/pbt-api-documentation/versions/ca6e9c8f430d/schema)