To cancel a meeting and to send an email regarding the meeting cancellation to the participants.
{
"openapi": "3.1.0",
"info": {
"title": "Cancel Meetings",
"description": "To cancel a meeting and to send an email regarding the meeting cancellation to the participants.",
"version": "8.0"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.Modules.ALL"
]
}
],
"paths": {
"/Events/{event}/actions/cancel": {
"post": {
"summary": "Cancel Meeting",
"operationId": "cancelMeetings",
"description": "To post the cancelMeeting mail",
"parameters": [
{
"$ref": "#/components/parameters/Event"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Contains Data properties",
"properties": {
"data": {
"type": "array",
"description": "Data contains whether to send meeting cancellation notification or not",
"maxItems": 10,
"items": {
"type": "object",
"additionalProperties": false,
"description": "Data Properties",
"properties": {
"send_cancelling_mail": {
"type": "boolean",
"description": "Mention whether to send meeting cancellation notification mail to participants or not."
}
},
"required": [
"send_cancelling_mail"
]
}
}
},
"required": [
"data"
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "The event is successfully cancelled",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": false,
"description": "Contains success response data",
"properties": {
"data": {
"type": "array",
"description": "Contains success response data",
"maxItems": 10,
"items": {
"type": "object",
"additionalProperties": false,
"description": "Success response Properties",
"properties": {
"code": {
"type": "string",
"description": "Success Code",
"enum": [
"SUCCESS"
]
},
"message": {
"type": "string",
"description": "Success Message",
"maxLength": 255
},
"status": {
"type": "string",
"description": "Success Status",
"enum": [
"success"
]
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Contains Cancel meeting's ID",
"properties": {
"id": {
"type": "string",
"description": "Detail_field - ID",
"maxLength": 255
}
},
"required": [
"id"
]
}
},
"required": [
"code",
"message",
"status",
"details"
]
}
}
},
"required": [
"data"
]
}
}
}
},
"400": {
"description": "The server cannot process the request because it contains invalid parameters or malformed data.",
"content": {
"application/json": {
"schema": {
"description": "Possible errors",
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "The request method is incorrect.Use the HTTP POST method to make this API call. Any other request method will result in this error.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_REQUEST_METHOD"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Required field not found! You have not specified the send_cancelling_mail key in the input body. Specify the mandatory key.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"MANDATORY_NOT_FOUND"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details",
"properties": {
"api_name": {
"type": "string",
"description": "Detail_field - api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail_field - json_path",
"maxLength": 255
}
},
"required": [
"api_name",
"json_path"
]
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "The id given seems to be invalid! Specify a valid Meeting ID.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_DATA"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details",
"properties": {
"api_name": {
"type": "string",
"description": "Detail_field - api_name",
"maxLength": 255
},
"json_path": {
"type": "string",
"description": "Detail_field - json_path",
"maxLength": 255
}
},
"required": [
"api_name",
"json_path"
]
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "The event is already cancelled. You are trying to cancel a meeting that is already cancelled. Specify a valid Meeting ID.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"NOT_ALLOWED"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "You cannot cancel the event without inviting participants. A meeting without participants cannot be cancelled. Invite participants to the meeting and cancel the meeting, or specify a Meeting ID with participants.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"NOT_ALLOWED"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "You cannot cancel the meeting after the meeting end time. A meeting cannot be cancelled after the meeting end time. Specify a valid Meeting ID.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"NOT_ALLOWED"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "No permission to perform an action on this record. The user does not have permission to access the record. Contact your system administrator.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"CANNOT_PERFORM_ACTION"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "permission denied. The user does not have permission to cancel the meeting. Contact your system administrator.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"NO_PERMISSION"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
},
{
"type": "object",
"additionalProperties": false,
"description": "Daily limit reached. 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.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"DAILY_LIMIT_EXCEEDED"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
}
]
}
}
}
},
"401": {
"description": "Unauthorized – Invalid or expired token.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "The access token you have used to make this API call does not have the required scope. Generate a new access token with the required scopes for this API.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"OAUTH_SCOPE_MISMATCH"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
}
]
}
}
}
},
"404": {
"description": "Unauthorized – Invalid or expired token.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"additionalProperties": false,
"description": "The request URL is incorrect.",
"properties": {
"code": {
"type": "string",
"description": "Error code",
"enum": [
"INVALID_URL_PATTERN"
]
},
"message": {
"type": "string",
"description": "Error message",
"maxLength": 255
},
"details": {
"type": "object",
"additionalProperties": false,
"description": "Error details"
},
"status": {
"type": "string",
"description": "Error Status",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
]
}
]
}
}
}
}
},
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.Modules.Events.update"
]
}
]
}
}
},
"components": {
"parameters": {
"Event": {
"name": "event",
"in": "path",
"required": true,
"schema": {
"type": "string",
"maxLength": 255
},
"description": "This refers to the Event's id that need to be cancel"
}
},
"securitySchemes": {
"iam-oauth2-schema": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
"refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
"scopes": {
"ZohoCRM.Modules.ALL": "Full access to Meetings module",
"ZohoCRM.Modules.Events.update": "Update access to Meetings module"
}
}
}
}
}
}
}