Sign in
iMessage

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.

post/v1/imessage/senders

Request body

profileIdstring required

Profile to attach the sender to

senderstring required

The provider-provisioned sender handle: a phone number in international format (e.g. +18305551234) or an email address

displayNamestring
provider'loopmessage'

Delivery provider. Defaults to the platform default.

Response

Sender registered

successboolean

Changes

Changed in 2 of the 55 revisions of this API.5

  • 2c04683ce6944See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 339f59df69dd1See the full diff
    • ○

      endpoint added

      endpoint-added