Method: GetCustByStatus

Method Type: Post

This method will be called by your application to do a bulk look up of customer status from the store you request within your auth string with a maximum of 200 records returned at one time. You may search one status at a time.

The CRM Text SMS API has four Customer statuses. They are:

New Guest
The Customer has never before been asked to opt-in to that store. In the CRM Text platform this would be considered customer type “1”.

Opted-In
The Customer has successfully opted-in and can receive messages. In the CRM Text platform this would be considered customer type “3”.

Opted-Out
The Customer has successfully opted-out and will not get any further messages until opting back in. In the CRM Text platform this would be considered customer type “5”.

Pending
The Customer received the opt-in request but has not yet replied YES to the message. In the CRM Text platform this would be considered customer type “2”.

  Restrictions


  • A valid customer status in the string.
  • A max record count of 200

  Suggestions


  • Searching pending status allows you to get a better handle on your conversion rates.

Request Example

Get Bulk Customer Opt-In Status:
https://restapi.crmtext.com/smapi/rest?method=getcustbystatus&status=opted-in&offset=0&count=200


Request Parameters

Name Required Value Description
status Yes String Either:
"opted-in"
"opted-out"
"pending"
"new guest"
offset Yes String Offset of the row to start from. For example if you select an offset of "300" and a count of "100" your returned value will be records 301-401 based on date added to our database.
count Yes String The number of records you wish to receive up to a maximum value of 200.

XML Sample Successful Response

1
2
3
4
5
6
7
8
9
10
11
12
13
<response op= "getcustbystatus" status= "200" message= "ok">
<customer>
<status>opted-in</status>
<count>2</count>
<records>
<firstname>John</firstname>
<lastname>Queue</lastname>
<mobile>9993334455</mobile>
<firstname/>
<lastname/>
<mobile>9994447788</mobile>
</records>
</customer>
</response>

XML Sample Error Response

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