Messaging · iMessage

Register an iMessage sender

Registers an iMessage sender.

POSThttps://api.pozy.ai/v1/imessage/senders
Not available yetregisterImessageSender

Guide: iMessage

Request

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

This endpoint is not available yet. Calls return 403 feature_not_available.

Request body

application/json, required

  • profileIdstringrequired
  • senderstringrequired
  • displayNamestring

    Up to 100 characters.

  • providerstring

    One of standard.

Example

curl -X POST "https://api.pozy.ai/v1/imessage/senders" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "profileId": "6a0b6573846efc28aaa9a3ff",
  "sender": "string"
}'

Response

200 on success

  • successboolean
  • accountobject
    9 child fields
    • idstring
    • platformstring

      One of imessage.

    • senderstring
    • optInLinkstring

      Can be null.

    • displayNamestring
    • profileIdstring

      Can be null.

    • providerstring
    • senderVerifiedboolean
    • isActiveboolean
200 response
{
  "success": true,
  "account": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "imessage",
    "sender": "string",
    "optInLink": "string",
    "displayName": "Acme",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "provider": "string",
    "senderVerified": true,
    "isActive": true
  }
}

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