Method: OptOutCustomer

Method Type: Post

This method will be called by your application to opt-out a customer out of the store you assign within your auth string. After completion, the customer can receive no further text messages from the store and the customer status will change to opted-out. This method is only used for non handset initiated opt-outs. At anytime the Customer may send STOP or QUIT to the short code they’ve opted-in to and the CRM Text SMS API will automatically reply with the opt-out confirmation message.

After the opt-out is completed, the CRM Text SMS API will release the mobile subscriber from the assigned communication short code and designate the customers's status as opted-out (Equals "5" in the API). CRM Text will also retain the mobile subscriber’s status for the life of the store.

If you do regain consent from the mobile subscriber to opt back in, you may use OptInCustomer to make the Customer an opted-in subscriber to the store.

When using this call, the CRM Text SMS API will pull the default SMS opt-out template from your store. You can learn more about how to edit these templates here.


  Restrictions


  • We ask for and require that you send us Customer phone numbers as 10 digits only. (Example: 9995551234)
  • Messages are limited to 1600 characters. But please read this so you know why you should stick to 160 characters per text message.
  • MMS is not supported in this method
  • Any further store initiated messaging to the mobile subscriber after opt-out will be blocked.

  Suggestions


  • If the customer calls you to opt-out please quickly make sure that takes place. Mobile subscribers take their devices seriously and suspected abuse of a customer’s desire to opt-out without action taken to do so will result in violation of our terms & conditions and result in immediate account suspension and termination.
  • If you are interested in creating your own opt-in templates via the API please contact support@crmtext.com.

Request Example

Opt-in Customer
https://restapi.crmtext.com/smapi/rest?method=optoutcustomer&phone_number=


Request Parameters

Name Required Value Description
phone_number yes integer 10 digit mobile number. (Example: 9995551234)

XML Sample Successful Response

1
2
3
4
5
6
7
8
9
10
<response op= "optoutcustomer" status= "200" message= "ok">
<customer>
<custId>09887654321</custId>
<subacct>1234</subacct>
<timestamp>2014-08-11 14:23:36</timestamp>
<optinStatus>5<optinstatus>
<custName>John Queue</custName>
<custMobile>9992224488</custMobile>
</customer>
</response>

XML Sample Error Response

1
2
<response op= "optoutcustomer" status= "4xx" message= "reason for Error">
</response>