Sign in
iMessage

Start an iMessage group chat

Creates a group chat from one of your senders and sends its first message. The provider processes it asynchronously: the response carries the request id, and the thread appears in the inbox (with its group conversation id) on the first webhook. Starting a group counts as messaging new contacts, so the sender needs the provider's init-conversations add-on and the same sending intervals apply; without it the request fails with 409 recipient_must_message_first. WhatsApp groups need a name.

post/v1/imessage/groups

Request body

accountIdstring required

The iMessage account (sender) that opens the group

contactsstring[] required

Participant handles (E.164 phones or iMessage emails)

textstring required

The first message

namestring

Group name (required for WhatsApp groups)

channel'imessage' | 'sms' | 'rcs' | 'whatsapp'

Response

Group creation accepted

successboolean
requestIdstring

The provider's request id (not the group id)

Changes

Changed in 2 of the 55 revisions of this API.5

  • 2c04683ce6944See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 339f59df69dd1See the full diff
    • ○

      endpoint added

      endpoint-added