Skip to main content
POST
imessage.group.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by imessage.senders.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
contacts
string[]
required

Two to ten participant addresses.

Required array length: 2 - 10 elements

Phone number including country code, or an email address.

Maximum string length: 320
text
string
required

Initial message sent while creating the group.

Required string length: 1 - 9999
name
string

Optional group name, when supported.

Required string length: 1 - 32
channel
enum<string>
default:imessage

The actual messaging channel.

Available options:
imessage,
sms,
rcs,
whatsapp
allowFallback
boolean
default:false

Allow channel downgrade for the initial message.

Response

The result

status
string
required

A persisted group identifier was confirmed.

Allowed value: "created"
participants
string[]

Confirmed participant addresses.

Phone number including country code, or an email address.

Maximum string length: 320
ref
string

Reference to what this call created. Pass it as ref to imessage.group.get.