API ReferenceCalendar events
Cancel a calendar event with a reason
Soft-cancels the event so it remains reportable (which lead, why, when).
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/crm/calendar/events/string/cancel" \ -H "Content-Type: application/json" \ -d '{ "reason": "RESCHEDULED" }'{
"allDay": true,
"attendees": [
{
"email": "string",
"name": "string",
"status": "PENDING",
"userId": "string"
}
],
"cancellationNote": "string",
"cancellationReason": "RESCHEDULED",
"cancelledAt": "2019-08-24T14:15:22Z",
"cancelledBy": "string",
"category": "DEFAULT",
"color": "string",
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"customer": {
"email": "string",
"id": "string",
"name": "string",
"phone": "string"
},
"customerId": "string",
"description": "string",
"endTime": "2019-08-24T14:15:22Z",
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"googleEventId": "string",
"id": "string",
"lastSyncedAt": "2019-08-24T14:15:22Z",
"lead": {
"email": "string",
"firstName": "string",
"id": "string",
"instagramHandle": "string",
"lastName": "string",
"phone": "string"
},
"leadId": "string",
"location": "string",
"onlineMeetingUrl": "string",
"opportunity": {
"id": "string",
"name": "string",
"status": "string"
},
"opportunityId": "string",
"outlookEventId": "string",
"owner": {
"displayName": "string",
"id": "string",
"username": "string"
},
"ownerId": "string",
"reminders": [
{
"minutesBefore": 0,
"type": "NOTIFICATION"
}
],
"startTime": "2019-08-24T14:15:22Z",
"status": "SCHEDULED",
"subsidiary": {
"color": "string",
"id": "string",
"name": "string"
},
"subsidiaryId": "string",
"syncSource": "GOOGLE",
"tenantId": "string",
"title": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"visibility": "PRIVATE"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}