Register an iMessage sender
Registers a provider-provisioned iMessage sender (a phone number or an
email handle) that YOU already own on a profile, creating an
imessage account that sends and receives through the inbox
conversation endpoints. To have Zernio order a new sender for you, use
POST /v1/imessage/senders/order instead. Registration attaches the
monthly sender fee (billed while active) and requires a payment method
(402 without one). One sender per profile: re-registering the SAME
handle refreshes it; a different handle returns 409 until the existing
sender is canceled.
Authorization
bearerAuth API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
{ "success": true, "account": { "id": "string", "platform": "imessage", "sender": "string", "optInLink": "string", "displayName": "string", "profileId": "string", "provider": "string", "senderVerified": true, "isActive": true }}Order a new iMessage sender
Orders a NEW dedicated iMessage sender from the delivery provider (compare with POST /v1/imessage/senders, which registers a sender you already own). Activation is asynchronous (minutes to a few hours): the response is 202 with the lifecycle object; poll GET /v1/imessage/senders/{senderId} or subscribe to the account.connected webhook. Billing starts at activation (monthly per sender, no proration). Requires usage-based billing and a valid payment method. Pass purchaseIntentId to make retries idempotent — the provider-side order is never retried automatically. Ordered phone senders include SMS/RCS fallback with call forwarding and the ability to message contacts who have not written first (sending intervals still apply).
Remove a participant from an iMessage group
Applied asynchronously by the provider.