This API allows you to opt-out a mobile number from specific list.
- You must supply only one of the parameters: keyword/list_id
- Url: https://mcpn.us/limeApi?ev=optout
- Parameters:
|
Parameter Name (Case Sensitive)
|
Value |
Description |
Remarks |
|
user (mandatory) |
Advertiser username |
The advertiser’s username that matches the api_id |
|
|
api_id (mandatory) |
Advertiser Api Id |
The advertiser’s api_id that matches the username |
Can be generated from edit profile |
|
mobile (mandatory) |
Mobile Number |
Mobile Number to send |
|
|
keyword (mandatory) |
Keyword as shown on the contact list wizard (Together with short code i.e. "pizza (71441-US)" or "pizza (07860024024)") |
The keyword that connected to the opt-in list. Cannot supplied together with list_id parameter |
|
|
list_id |
Opt-in List ID |
Cannot supplied together with keyword parameter |
|
Return Code
If the API succeeds then it will return with status code 200.
If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.Examples:
https://mcpn.us/limeApi?ev=optout&user=advertiser@gmpizza.com&api_id=q5JA73WRLy13822c&keyword=pizza (71441-US)&mobile=15555555555
https://mcpn.us/limeApi?ev=optout&user=advertiser@gmpizza.com&api_id=q5JA73WRLy13822c&list_id=1001&mobile=15555555555
Comments
0 comments
Article is closed for comments.