Messaging · iMessage

Update an iMessage sender

Updates an iMessage sender. Fields you leave out keep their current values.

PATCHhttps://api.pozy.ai/v1/imessage/senders/{senderId}
updateImessageSender

Guide: iMessage

Request

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

Path parameters

NameTypeNotes
senderIdrequiredstring

Request body

application/json, required

  • displayNamestring

    Up to 100 characters.

  • contactobject
    • firstNamestringrequired

      Up to 64 characters.

    • lastNamestring

      Up to 64 characters.

    • photoUrlstring (URL)

Example

curl -X PATCH "https://api.pozy.ai/v1/imessage/senders/68ef6f94df13738fb25f1e94" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "displayName": "Acme",
  "contact": {
    "firstName": "Acme"
  }
}'

Response

200 on success

  • successboolean
  • senderobject
    13 child fields
    • idstring
    • kindstring

      One of phone, email.

    • regionstring

      One of US, GB. Can be null.

    • handlestring

      Can be null.

    • optInLinkstring

      Can be null.

    • statusstring

      One of ordering, awaiting_payment, activating, active, suspended, canceled, failed.

    • priceCentsinteger
    • providerstring
    • profileIdstring
    • displayNamestring

      Can be null.

    • failureReasonstring

      Can be null.

    • accountIdstring

      Can be null.

    • createdAtstring (date-time)
200 response
{
  "success": true,
  "sender": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "kind": "phone",
    "region": "US",
    "handle": "acme",
    "optInLink": "string",
    "status": "ordering",
    "priceCents": 1,
    "provider": "string",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "displayName": "Acme",
    "failureReason": "string",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "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.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in iMessage