The API system will search in your account for the lead subscribed under that specific email, and it will subscribe the lead to the calendar.
Type | Parameters | Values |
POST | cmd* | calendar_subscribe |
POST | calendar_name* | string |
POST | class_name* | string |
POST | starting_date | string (DD Mmm YYYY) Timezone EST |
POST | starting_hour | string (HH:MM) Timezone EST |
* Required fields Here is an example:
'lead' => [
'email' => '[email protected]'
],
'actions' => [
'0' => [
'cmd' => 'calendar_subscribe',
'calendar_name' => 'First calendar',
'class_name' => 'First class',
'starting_date' => '16 Jan 2019',
'starting_hour' => '15:00',
]
]Success message:
{
"status": "Success",
"message": "Lead subscribed to class",
"type": "112"
}Error Cases:
Type Number | Message | Cause |
255 | Calendar cannot be empty |
|
256 | Class cannot be empty |
|
257 | Calendar does not exist |
|
258 | Class does not exist |
|
260 | Invalid date format |
|
261 | Date is in the past |
|
An example of an error message:
{
"status": "Error",
"message": "Class does not exist",
"type": "258"
}