Action: Cancel subscription to calendar
The API system will search in your account for the lead subscribed under that specific email, and it will cancel the subscription from the calendar.
Type | Parameters | Values |
POST | cmd* | calendar_cancel |
POST | calendar_name* | string |
POST | class_name* | string |
* Required fields
Here is an example:
'lead' => [ 'email' => 'example@email.com' ], 'actions' => [ '0' => [ 'cmd' => 'calendar_cancel', 'calendar_name' => 'First calendar', 'class_name' => 'First class' ] ]
Success message:
{
"status": "Success",
"message": "Lead unsubscribed from class",
"type": "113"
}
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 |
|
259 | No active/pending calendar subscription for this lead |
|
An example of an error message:
{
"status": "Error",
"message": "Class does not exist",
"type": "258"
}