Method: OptInCustomer

Method Type: Post

This method will be called by your application to create a Customer for the store you assign within your auth string and the CRM Text SMS API will then deliver an opt-in request text message to the Customer. It is required before you can send any text messages to a mobile device, except where otherwise noted. The opt-in request will come from a CRM Text communication short code. It is used in all opt-in scenarios (Webform, Paper Contract, Via an App), except for handset initiated keyword opt-ins.

The Customer will be put in a "Pending" status (Equals "4" in the API). The Customer must respond YES to that request before any further messages can be delivered. If the Customer responds YES, the CRM Text SMS API will automate an opt-in confirmation message alerting them that they’ve successfully opted-in and we will post the Customer’s updated opt-in status to your callback URL (Equals "3" in the API). The customer will now be assigned a communication short code and all 2-way SMS communication with the customer will occur on that assigned communication short code for the life of the opt-in.

SMS from a business to consumer is opt-in communication only and the double opt-in process is required by the Mobile Marketing Association for all non-mobile device initiated opt-ins.

When using this call, the CRM Text SMS API will pull the default SMS opt-in confirmation or request 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
  • The CRM Text SMS API will not deliver text messages to any Customer who has not responded YES to the opt-in request.
  • In the parameters, first and last name are required, however, you may leave each value blank as a first and last name are not required

  Suggestions


  • Make sure you have a daisy chain of approval from the Customer to that they want to opt-in to the store. That approval can be digital, written or even verbal. Mobile subscribers take their devices seriously and the blanket opting in of mobile numbers or other abuse will not be tolerated and is an immediate violation of our terms and conditions resulting in 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=optincustomer&firstname=&lastname=&phone_number=


Request Parameters

Name Required Value Description
firstname Yes string Mobile Subscriber's First Name. You may leave this value blank.
lastname Yes String Mobile Subscriber's Last Name. You may leave this value blank.
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= "optincustomer" status= "200" message= "ok">
<customer>
<custId>09887654321</custId>
<subacct>1234</subacct>
<timestamp>2014-08-11 14:23:36</timestamp>
<optinStatus>2<optinstatus>
<custName>John Queue</custName>
<custMobile>9992224488</custMobile>
</customer>
</response>

XML Sample Error Response

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