Messaging · iMessage

Add an iMessage sandbox contact

Adds an iMessage sandbox contact.

POSThttps://api.pozy.ai/v1/imessage/sandbox/contacts
addImessageSandboxContact

Guide: iMessage

Request

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

Request body

application/json, required

  • handlestringrequired

Example

curl -X POST "https://api.pozy.ai/v1/imessage/sandbox/contacts" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "handle": "acme"
}'

Response

201 on success

  • contactobject
    8 child fields
    • idstring
    • handlestring
    • statusstring

      One of pending, active.

    • joinTextstring
    • joinLinkstring
    • activatedAtstring (date-time)

      Can be null.

    • lastInboundAtstring (date-time)

      Can be null.

    • createdAtstring (date-time)
201 response
{
  "contact": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "handle": "acme",
    "status": "pending",
    "joinText": "Hello from Pozy",
    "joinLink": "string",
    "activatedAt": "2026-10-02T09:00:00.000Z",
    "lastInboundAt": "2026-10-02T09:00:00.000Z",
    "createdAt": "2026-10-02T09:00:00.000Z"
  }
}

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