AIairship
SMS

Opt-out of SMS messages

Changed on

This will mark an SMS channel as opted-out (inactive) and it will not receive alerts even when they are addressed in the future. To opt the user back in, call the registration function again with a valid opted_in value.

post/api/channels/sms/opt-out

Request

Request body

msisdnstring required

The mobile phone number you want to opt-out of SMS messages. Must be numeric characters only, without leading zeros. 15 digits maximum.

senderstring required

A long or short code the app is configured to send from. For example, 12345.

Response

The msisdn/channel is opted-out of SMS notifications.

okboolean

If true, the operation completed successfully.

Changes

  • ca569bd1394dRevision changes
    • breaking

      added the new required request property /

    • info

      the request property's minLength was decreased from 1 to 0