Create a new group chat and send an intro message

View as Markdown

Creates a new iMessage group from participant handles and sends the intro message. Returns as soon as the Mac agent confirms the UI create+send. groupId is best-effort and may be null — for follow-up messages, call /sendGroupMessage with the same participants and force=true (the agent resolves the chat from participants).

Authentication

X-App-Idstring

Your MessageBlue App ID, sent in clear on every request. It is paired with request signing: each request is also signed with your App Secret (see the Authentication tag). The App Secret itself is NEVER transmitted — it is only the HMAC signing key.

Headers

Idempotency-KeystringOptional

Optional: replays return the same cached create result for 24h.

Request

This endpoint expects an object.
participantslist of stringsRequired

At least two distinct phone numbers (E.164) or email handles.

introMessagestringRequired
agentNumberstringOptional

Optional agent to create the group from. If omitted, least-mapped available agent is chosen.

status_callbackstring or nullOptionalformat: "uri"

Response

Group created
okboolean
dataobject

Endpoint-specific payload wrapped in a standard success envelope.

metaobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
500
Internal Server Error
502
Bad Gateway Error
503
Service Unavailable Error
504
Gateway Timeout Error