Meeting Cancel API

Purpose

To cancel a meeting and to send an email regarding the meeting cancellation to the participants.

Endpoints

POST /Events/{event_id}/actions/cancel

Request Details

Request URL

{api-domain}/crm/{version}/Events/{event_id}/actions/cancel

Header

Authorization: Zoho-oauthtoken 100xx.92d4xxxxxxxxxxxxx15f52

Scope

scope= ZohoCRM.Modules.ALL
(or)
ZohoCRM.Modules.Events.{operation_type}

Possible operation types

ALL - Full access to Meetings module
UPDATE - Update Meetings

Sample Request

Copiedcurl "https://www.zylkercorp.zohoplatform.com/crm/v4/Events/4876876000001563018/actions/cancel"
-X POST
-H "Authorization: Zoho-oauthtoken 100xx.d92d4xxxxxxxxxxxxx15f52"

Note

Only if attendees have already been invited to the meeting can it be cancelled. After the end time, a meeting cannot be cancelled.
You can get the cancellation status of a meeting from the $event_cancelled key in the GET Meetings API response. For more information, refer to the Get Records API documentation.

Input JSON Keys

send_cancelling_mailBoolean, mandatory
Mention whether to send meeting cancellation notification mail to participants or not.

Sample Input

Copied{
    "data": [
        {
           "send_cancelling_mail"  : false
        }
    ]
}

Possible Errors

INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above.
INVALID_DATAHTTP 400
The id given seems to be invalid
Resolution: Specify a valid Meeting ID.
MANDATORY_NOT_FOUNDHTTP 400
Required field not found
Resolution: You have not specified the send_cancelling_mail key in the input body. Specify the mandatory key.
NOT_ALLOWEDHTTP 400
The event is already cancelled
Resolution: You are trying to cancel a meeting that is already cancelled. Specify a valid Meeting ID.
NOT_ALLOWEDHTTP 400
You cannot cancel the event without inviting participants
Resolution: A meeting without participants cannot be cancelled. Invite participants to the meeting and cancel the meeting, or specify a Meeting ID with participants.
NOT_ALLOWEDHTTP 400
You cannot cancel the meeting after the meeting end time
Resolution: A meeting cannot be cancelled after the meeting end time. Specify a valid Meeting ID.
CANNOT_PERFORM_ACTIONHTTP 400
no permission to perform an action on this record
Resolution: The user does not have permission to access the record. Contact your system administrator.
NO_PERMISSIONHTTP 400
permission denied
Resolution: The user does not have permission to cancel the meeting. Contact your system administrator.
DAILY_LIMIT_EXCEEDEDHTTP 400
Daily limit reached
Resolution: The user has reached the daily mail limit. No more emails can be sent. You can choose not to send the cancellation email, or cancel the meeting the next day.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have the required OAUTH SCOPE. Create a new client with valid scope. Refer to scope section above for more details.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Response

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "id": "4876876000001563018"
            },
            "message": "The event is successfully cancelled",
            "status": "success"
        }
    ]
}