Create Appointment API
If you have your own system and would like to create a new appointment without our dashboard, we have just created an API allowing you to do just that. This API is for server to server communication, in case you have your own CRM system or something similar to manage your customer base.
Url: https://mcpn.us/limeApi?ev=createAppointment
You can supply the following parameters
Parameters (case sensitive, bold are mandatory):
Parameter Name (Case Sensitive)
|
Value |
Description |
Default Value |
user |
Advertiser username |
The advertiser’s username that matches the api_id and own the loyalty program |
None |
api_id |
Advertiser Api Id |
The Advertiser's api_id that matches the username |
Generated from edit profile |
date |
String with the format 'yyyy-MM-dd HH:mm:ss' with GMT time zone. i.e. 2017-05-18 17:00:00 |
The appointment date |
|
mobile |
String |
Mobile number of the participant |
|
message |
String |
The message that will be sent to the mobile prior to the appointment. To this message will be add more text in case the appointment type is a Confirmation or ShortConfirmation No need to add "Reply 'C' to confirm …." The system will add it automatically |
|
type |
String |
The confirmation type Must be one of the followings: Reminder – Send only reminder Confirmation – Send message and request confirmation or miss or behind schedule or request to reschedule ShortConfirmation – Send message and request a confirmation or miss |
Default value is Reminder |
notifyHours |
Number |
Set the hours before appointment to send the notification. Can be only one of: 0.5 / 1 / 2 / 3 / 6 / 24 / 48 |
Default value is 1 hour |
first |
String |
First name of the recipient |
|
last |
String |
Last name of the recipient |
|
targetOptInList |
Number |
Opt-in list ID that the recipient will opt-in to |
|
notifyEmail |
String |
Email address to notify when a recipient reply to the Confirmation message |
|
notifyNumber |
String |
Mobile number to notify when a recipient reply to the Confirmation message |
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 body.
Example:
https://mcpn.us/limeApi?ev=createAppointment&user=advertiseruser&api_id=a5SNH43WyAA83SWLK&date=2017-05-09 16:00:00&mobile=15555555555&message=Your appointment is at %TIME%
Comments
0 comments
Article is closed for comments.