I am trying to use the FUEL API to unsubscribe a mobile number from a particular keyword on a private shortcode. I would be fine with a global opt out on that private shortcode, as well.

I have tried a MO message (/sms/v1/queueMO/) with different unsubscribe keywords (STOP, UNSUBSCRIBE, QUIT, etc.) and the response is always that that keyword does not exist. I have tried using the original keyword as the verb and unsubscribe keywords (see above) as nouns but that doesn't work either (I get a text saying "Sorry, there was an error. Please try again.")

I have also tried to use message contact send (/sms/v1/messageContact/{messageId}/send) to set the subscribe and resubscribe values as FALSE but this does not seem to do the trick, either.

I am thinking that a custom import definition would do the trick but I want to avoid that as it would require the creation and maintenance of a DE outside the Mobile Connect tool and then additional API calls to update that DE and then trigger an import. Not to mention it wouldn't be near-realtime.

Does anyone know if there is an API call that can simply unsubscribe someone (a mobile number) from an SMS campaign/keyword/shortcode?

Use Case for this is allowing a user to manage their SMS campaign subscriptions from a Web Portal - User Preferences page.

  • Quick clarification question: we're talking about Mobile Connect right? Not the more antiquated ET SMS product?
    – Timothy
    Commented May 9, 2014 at 15:57
  • Yes, Mobile Connect. Commented May 9, 2014 at 16:00

2 Answers 2


To unsubscribe from ALL keywords for a certain shortcode, you can send a QueueMO call to that shortcode with the message text of "STOP".

ExactTarget has informed me that their system does not discriminate against QueueMO calls within the API and true MO texts from the physical device.

Call used:

    "mobileNumbers" : [
    "shortCode" : "12345",
    "messageText" : "STOP"
  • 1
    It's not working for me. I get the below error. Thanks in Advance. { "errors": [ "Client, ShortCode, Keyword combination is invalid." ] }
    – Ashwin
    Commented Aug 11, 2014 at 22:51
  • Short Code or Message Text are not valid. What kind of Message do you have set up in Mobile Connect? Commented Aug 13, 2014 at 2:07
  • 2
    Is there a way to unsubscribe from certain keywords. For example, there a message "Hello world" that tied to keyword "HELLO" If a user unsubscribes to "HELLO" keyword, we won't send "Hello World" to that user! Thanks!
    – tkhuynh
    Commented Mar 28, 2018 at 21:06
  • Just wondering if anyone might have an answer to the above comment about whether a method exists to opt-out at a keyword level through the REST API?
    – Mark P
    Commented Sep 18, 2018 at 14:23
  • @MarkP Nope. Keyword level opt-out is not possible yet.
    – sfdcFanBoy
    Commented Nov 7, 2018 at 7:24

The optout can occur at the MID level using a Custom Stop. So setup a second STOP like 'STOP1' keyword in the BU you want to unsubscribe from. This will limit it to just that BU.

There is no reason that QueueMO call wouldn't work. Question would be is the ClientID/Secret you are using to trigger the call owned in the MID that holds the STOP. Because if not, then that error makes sense as the accessToken is MID Specific in context for what is matching to look for.

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .