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": "The lead will be unsubscribed from calendar {calendar_name}", "type": "113" }
Error Cases:
Type Number | Message | Cause |
255 | calendar_name cannot be empty. Nothing done |
|
256 | class_name cannot be empty. Nothing done |
|
257 | Invalid calendar. Nothing done |
|
258 | Invalid calendar class. Nothing done |
|
259 | There is no active/pending calendar subscription for this lead. Nothing done |
|
An example of an error message:
{ "status": "Error", "message": "Invalid calendar class. Nothing done", "type": "258" }