Messaging · iMessage

Start an iMessage group chat

Starts an iMessage group chat.

POSThttps://api.pozy.ai/v1/imessage/groups
createImessageGroup

Guide: iMessage

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Authentication

Request body

application/json, required

  • accountIdstringrequired
  • contactsarray of stringrequired

    At least 2 items. Up to 32 items.

  • textstringrequired

    Up to 10000 characters.

  • namestring

    Up to 32 characters.

  • channelstring

    One of imessage, sms, rcs, whatsapp. Default imessage.

Example

curl -X POST "https://api.pozy.ai/v1/imessage/groups" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accountId": "696e0b682d0a31188e7a2ba9",
  "contacts": [
    "string"
  ],
  "text": "Hello from Pozy"
}'

Response

202 on success

  • successboolean
  • requestIdstring
202 response
{
  "success": true,
  "requestId": "62281f30b62a8870b34602a4"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in iMessage