Sign in

v1

latestOpenAPI 3.0.12026-08-0640103344.9 KB
Group

Add Group

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.
post/orgunit/{orgunitId}/groups

Path parameters

orgunitIdstring required

orgunitId

Request body

namestring required

The official descriptive name of the group. Must be unique within the organization unit.

descriptionstring nullable

An optional text summary providing additional context or organizational details about the group's purpose.

infoboolean

Set to true to establish this as an INFO group used exclusively for information-only keywords. When true, the group cannot maintain subscribers.

whatsappboolean

Set to true to establish this as a WHATSAPP group used exclusively for WhatsApp related subscribers.

notificationMobileNosstring[] nullable

An array of mobile phone numbers that will receive notifications regarding inbound messages.

notificationEmailsstring[] nullable

An array of administrative email addresses that will receive notifications regarding inbound messages.

chatEnabledboolean

Enables or disables two-way interactive chat messaging (inbox) for subscribers within this group.

autoReponseboolean

When set to true, enables automated system responses to be sent back to subscribers based inbound messages.

autoResponseMessagestring nullable

The text payload delivered to a subscriber as a standard automated fallback response when 'autoReponse' is enabled.

helpMessagestring nullable

The custom compliance message sent to non-subscribers who text the 'HELP' keyword to your communication code.

stopMessagestring nullable

The custom compliance confirmation text sent to non-subscribers who opt out by replying with the 'STOP' keyword.

optinMessagestring nullable

The custom welcome/compliance message delivered to a subscriber immediately after successfully opting into this group.

Response

Success

appCodestring nullable
messagestring nullable
isErrorboolean