Sign in
iMessage

Subscribe or opt out an iMessage contact

Opted-out contacts are refused at send time (409 recipient_opted_out) until re-subscribed. Their inbound messages still arrive. Scoped to your account: it does not change the contact's state with other businesses.

post/v1/imessage/audience/subscription

Request body

accountIdstring required
conversationIdstring required
subscribedboolean required

Response

Updated

successboolean
conversationIdstring
subscribedboolean

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