VintaSchedule
← Schema Reference

Mutations

Write operations on POST /graphql/ — 51 in all. Each shows its arguments, return type, and an example request.
approveExternalEventChangeRequest
Approve external event change request.
Arguments
  • id:Int!
Example
mutation ApproveExternalEventChangeRequest {
  approveExternalEventChangeRequest(id: 10) {
    errorMessage
    success
    changeRequest {
      created
      eventId
      id
      kind
      modified
      proposedValues
    }
  }
}
batchUpdateAvailabilityWindows
Batch update availability windows.
Example
mutation BatchUpdateAvailabilityWindows {
  batchUpdateAvailabilityWindows(input: { calendarId: 10, operations: [{ action: "<action>" }], organizationId: 10 }) {
    errorMessage
    success
    availableTimes {
      created
      endTime
      id
      modified
      startTime
    }
  }
}
cancelEvent
Cancel event.
Arguments
Example
mutation CancelEvent {
  cancelEvent(input: { calendarId: 10, deleteSeries: true, eventId: 10, organizationId: 10 }) {
    success
  }
}
cancelEventWithCode
Cancel event with code.
Arguments
Example
mutation CancelEventWithCode {
  cancelEventWithCode(input: { code: "<code>" }) {
    errorCode
    errorMessage
    success
    event {
      created
      description
      durationSeconds
      endTime
      externalId
      id
    }
  }
}
checkToken
Check token.
Arguments
  • systemUserId:Int!
  • token:String!
Example
mutation CheckToken {
  checkToken(
    systemUserId: 10
    token: "<token>"
  ) {
    tokenValid
  }
}
createAvailabilityWindow
Create availability window.
Example
mutation CreateAvailabilityWindow {
  createAvailabilityWindow(input: { calendarId: 10, endTime: "2025-01-01T00:00:00Z", organizationId: 10, startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>" }) {
    errorMessage
    success
    availableTime {
      created
      endTime
      id
      modified
      startTime
    }
  }
}
createBlockedTime
Create blocked time.
Example
mutation CreateBlockedTime {
  createBlockedTime(input: { calendarId: 10, endTime: "2025-01-01T00:00:00Z", organizationId: 10, reason: "<reason>", startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>" }) {
    errorMessage
    success
    blockedTime {
      created
      endTime
      externalId
      id
      modified
      startTime
    }
  }
}
createBookingPolicy
Create booking policy.
Example
mutation CreateBookingPolicy {
  createBookingPolicy(input: { bufferAfterSeconds: 10, bufferBeforeSeconds: 10, isOrganizationDefault: true, leadTimeSeconds: 10, maxHorizonSeconds: 10 }) {
    success
    policy {
      bufferAfterSeconds
      bufferBeforeSeconds
      calendarGroupId
      calendarId
      created
      id
    }
  }
}
createCalendar
Create calendar.
Arguments
Example
mutation CreateCalendar {
  createCalendar(input: { isPrivate: true, name: "<name>", organizationId: 10 }) {
    errorMessage
    success
    calendar {
      calendarType
      capacity
      created
      description
      email
      externalId
    }
  }
}
createCalendarBookingCode
Create calendar booking code.
Example
mutation CreateCalendarBookingCode {
  createCalendarBookingCode(input: { calendarId: 10, organizationId: 10 }) {
    code
    errorCode
    errorMessage
    id
    success
  }
}
createCalendarBundle
Create calendar bundle.
Example
mutation CreateCalendarBundle {
  createCalendarBundle(input: { childrenIds: [10], isPrivate: true, name: "<name>", organizationId: 10 }) {
    errorMessage
    success
    bundle {
      description
      id
      isPrivate
      name
    }
  }
}
createCalendarCancellationBookingCode
Create calendar cancellation booking code.
Arguments
Example
mutation CreateCalendarCancellationBookingCode {
  createCalendarCancellationBookingCode(input: { calendarId: 10, eventId: 10, organizationId: 10 }) {
    code
    errorCode
    errorMessage
    id
    success
  }
}
createCalendarEventWithCode
Create calendar event with code.
Example
mutation CreateCalendarEventWithCode {
  createCalendarEventWithCode(input: { code: "<code>", description: "<description>", endTime: "2025-01-01T00:00:00Z", externalAttendee: { email: "<email>", name: "<name>" }, startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>", title: "<title>" }) {
    errorCode
    errorMessage
    success
    event {
      created
      description
      durationSeconds
      endTime
      externalId
      id
    }
  }
}
createCalendarGroup
Create calendar group.
Arguments
Example
mutation CreateCalendarGroup {
  createCalendarGroup(input: { description: "<description>", isPrivate: true, name: "<name>", organizationId: 10, slots: [{ calendarIds: [10], description: "<description>", name: "<name>", order: 10, requiredCount: 10 }] }) {
    errorMessage
    success
    group {
      created
      description
      id
      isPrivate
      modified
      name
    }
  }
}
createCalendarGroupBookingCode
Create calendar group booking code.
Example
mutation CreateCalendarGroupBookingCode {
  createCalendarGroupBookingCode(input: { calendarGroupId: 10, organizationId: 10 }) {
    code
    errorCode
    errorMessage
    id
    success
  }
}
createCalendarGroupCancellationBookingCode
Create calendar group cancellation booking code.
Example
mutation CreateCalendarGroupCancellationBookingCode {
  createCalendarGroupCancellationBookingCode(input: { calendarGroupId: 10, eventId: 10, organizationId: 10 }) {
    code
    errorCode
    errorMessage
    id
    success
  }
}
createCalendarGroupEvent
Create calendar group event.
Example
mutation CreateCalendarGroupEvent {
  createCalendarGroupEvent(input: { attendances: [{ userId: 10 }], description: "<description>", endTime: "2025-01-01T00:00:00Z", externalAttendances: [{ externalAttendee: {} }], groupId: 10, organizationId: 10, slotSelections: [{ calendarIds: [10], slotId: 10 }], startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>", title: "<title>" }) {
    errorMessage
    success
    event {
      created
      description
      durationSeconds
      endTime
      externalId
      id
    }
  }
}
createCalendarGroupEventWithCode
Create calendar group event with code.
Example
mutation CreateCalendarGroupEventWithCode {
  createCalendarGroupEventWithCode(input: { code: "<code>", description: "<description>", endTime: "2025-01-01T00:00:00Z", externalAttendee: { email: "<email>", name: "<name>" }, slotSelections: [{ calendarIds: [10], slotId: 10 }], startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>", title: "<title>" }) {
    errorCode
    errorMessage
    success
    event {
      created
      description
      durationSeconds
      endTime
      externalId
      id
    }
  }
}
createCalendarGroupRescheduleBookingCode
Create calendar group reschedule booking code.
Example
mutation CreateCalendarGroupRescheduleBookingCode {
  createCalendarGroupRescheduleBookingCode(input: { calendarGroupId: 10, eventId: 10, organizationId: 10 }) {
    code
    errorCode
    errorMessage
    id
    success
  }
}
createCalendarRescheduleBookingCode
Create calendar reschedule booking code.
Arguments
Example
mutation CreateCalendarRescheduleBookingCode {
  createCalendarRescheduleBookingCode(input: { calendarId: 10, eventId: 10, organizationId: 10 }) {
    code
    errorCode
    errorMessage
    id
    success
  }
}
createInvitation
Create invitation.
Arguments
Example
mutation CreateInvitation {
  createInvitation(input: { organizationId: "<organizationId>", role: ADMIN, sendEmail: true, userEmail: "<userEmail>" }) {
    inviteUrl
    token
    invitation {
      email
      expiresAt
      id
    }
  }
}
createOrganization
Create organization.
Example
mutation CreateOrganization {
  createOrganization(input: { name: "<name>" }) {
    organization {
      id
      name
    }
  }
}
createResourceCalendar
Create resource calendar.
Example
mutation CreateResourceCalendar {
  createResourceCalendar(input: { isPrivate: true, manageAvailableWindows: true, name: "<name>", organizationId: 10 }) {
    errorMessage
    success
    calendar {
      calendarType
      capacity
      created
      description
      email
      externalId
    }
  }
}
createScopedSystemUser
Create scoped system user.
Example
mutation CreateScopedSystemUser {
  createScopedSystemUser(input: { availableResources: ["<availableResources>"], integrationName: "<integrationName>", scopedToUserId: 10 }) {
    availableResources
    id
    integrationName
    isActive
    scopedToUserId
    token
  }
}
createSystemUserToken
Create system user token.
Example
mutation CreateSystemUserToken {
  createSystemUserToken(input: { integrationName: "<integrationName>", organizationId: "<organizationId>", resources: ["<resources>"] }) {
    systemUserId
    token
  }
}
createWebhookConfiguration
Create webhook configuration.
Example
mutation CreateWebhookConfiguration {
  createWebhookConfiguration(input: { eventType: "<eventType>", headers: {}, url: "<url>" }) {
    errorMessage
    configuration {
      created
      eventType
      headers
      id
      modified
      url
    }
  }
}
deleteAvailabilityWindow
Delete availability window.
Example
mutation DeleteAvailabilityWindow {
  deleteAvailabilityWindow(input: { availableTimeId: 10, calendarId: 10, organizationId: 10 }) {
    errorMessage
    success
  }
}
deleteBlockedTime
Delete blocked time.
Example
mutation DeleteBlockedTime {
  deleteBlockedTime(input: { blockedTimeId: 10, calendarId: 10, organizationId: 10 }) {
    errorMessage
    success
  }
}
deleteBookingPolicy
Delete booking policy.
Example
mutation DeleteBookingPolicy {
  deleteBookingPolicy(input: { policyId: 10 }) {
    success
  }
}
deleteCalendarGroup
Delete calendar group.
Example
mutation DeleteCalendarGroup {
  deleteCalendarGroup(input: { groupId: 10, organizationId: 10 }) {
    errorMessage
    success
  }
}
deleteSystemUser
Delete system user.
Arguments
Example
mutation DeleteSystemUser {
  deleteSystemUser(input: { systemUserId: 10 }) {
    errorMessage
    success
  }
}
deleteWebhookConfiguration
Delete webhook configuration.
Example
mutation DeleteWebhookConfiguration {
  deleteWebhookConfiguration(input: { id: 10 }) {
    errorMessage
    success
  }
}
disableCalendarBundle
Disable calendar bundle.
Example
mutation DisableCalendarBundle {
  disableCalendarBundle(input: { bundleId: 10, organizationId: 10 }) {
    errorMessage
    success
  }
}
disableResourceCalendar
Disable resource calendar.
Example
mutation DisableResourceCalendar {
  disableResourceCalendar(input: { calendarId: 10, organizationId: 10 }) {
    errorMessage
    success
  }
}
importResourceCalendars
Import resource calendars.
Example
mutation ImportResourceCalendars {
  importResourceCalendars(input: { organizationId: 10 }) {
    errorMessage
    success
  }
}
rejectExternalEventChangeRequest
Reject external event change request.
Arguments
  • id:Int!
Example
mutation RejectExternalEventChangeRequest {
  rejectExternalEventChangeRequest(id: 10) {
    errorMessage
    success
    changeRequest {
      created
      eventId
      id
      kind
      modified
      proposedValues
    }
  }
}
rescheduleCalendarEvent
Reschedule calendar event.
Example
mutation RescheduleCalendarEvent {
  rescheduleCalendarEvent(input: { calendarId: 10, endTime: "2025-01-01T00:00:00Z", eventId: 10, organizationId: 10, startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>" }) {
    created
    description
    durationSeconds
    endTime
    externalId
    id
    attendances {
      created
      id
      modified
      status
    }
    attendeeMemberships {
      organizationId
      role
      userId
    }
  }
}
rescheduleCalendarEventWithCode
Reschedule calendar event with code.
Example
mutation RescheduleCalendarEventWithCode {
  rescheduleCalendarEventWithCode(input: { code: "<code>", endTime: "2025-01-01T00:00:00Z", startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>" }) {
    errorCode
    errorMessage
    success
    event {
      created
      description
      durationSeconds
      endTime
      externalId
      id
    }
  }
}
rescheduleCalendarGroupEvent
Reschedule calendar group event.
Example
mutation RescheduleCalendarGroupEvent {
  rescheduleCalendarGroupEvent(input: { endTime: "2025-01-01T00:00:00Z", eventId: 10, organizationId: 10, startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>" }) {
    created
    description
    durationSeconds
    endTime
    externalId
    id
    attendances {
      created
      id
      modified
      status
    }
    attendeeMemberships {
      organizationId
      role
      userId
    }
  }
}
rescheduleCalendarGroupEventWithCode
Reschedule calendar group event with code.
Example
mutation RescheduleCalendarGroupEventWithCode {
  rescheduleCalendarGroupEventWithCode(input: { code: "<code>", endTime: "2025-01-01T00:00:00Z", startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>" }) {
    errorCode
    errorMessage
    success
    event {
      created
      description
      durationSeconds
      endTime
      externalId
      id
    }
  }
}
revokeBookingCode
Revoke booking code.
Example
mutation RevokeBookingCode {
  revokeBookingCode(input: { id: 10, organizationId: 10 }) {
    code
    errorCode
    errorMessage
    id
    success
  }
}
Schedule event.
Arguments
Example
mutation ScheduleEvent {
  scheduleEvent(input: { attendeeUserIds: [10], calendarId: 10, description: "<description>", endTime: "2025-01-01T00:00:00Z", externalAttendees: [{ email: "<email>", name: "<name>" }], organizationId: 10, startTime: "2025-01-01T00:00:00Z", timezone: "<timezone>", title: "<title>" }) {
    created
    description
    durationSeconds
    endTime
    externalId
    id
    attendances {
      created
      id
      modified
      status
    }
    attendeeMemberships {
      organizationId
      role
      userId
    }
  }
}
updateAvailabilityWindow
Update availability window.
Example
mutation UpdateAvailabilityWindow {
  updateAvailabilityWindow(input: { availableTimeId: 10, calendarId: 10, organizationId: 10 }) {
    errorMessage
    success
    availableTime {
      created
      endTime
      id
      modified
      startTime
    }
  }
}
updateBlockedTime
Update blocked time.
Example
mutation UpdateBlockedTime {
  updateBlockedTime(input: { blockedTimeId: 10, calendarId: 10, organizationId: 10 }) {
    errorMessage
    success
    blockedTime {
      created
      endTime
      externalId
      id
      modified
      startTime
    }
  }
}
updateBookingPolicy
Update booking policy.
Example
mutation UpdateBookingPolicy {
  updateBookingPolicy(input: { policyId: 10 }) {
    success
    policy {
      bufferAfterSeconds
      bufferBeforeSeconds
      calendarGroupId
      calendarId
      created
      id
    }
  }
}
updateBranding
Update branding.
Arguments
Example
mutation UpdateBranding {
  updateBranding(input: { appName: "<appName>", logoUrl: "<logoUrl>", primaryColor: "<primaryColor>", secondaryColor: "<secondaryColor>", supportEmail: "<supportEmail>" }) {
    branding {
      appName
      id
      logoUrl
      primaryColor
      secondaryColor
    }
  }
}
updateCalendar
Update calendar.
Arguments
Example
mutation UpdateCalendar {
  updateCalendar(input: { calendarId: 10, organizationId: 10 }) {
    errorMessage
    success
    calendar {
      calendarType
      capacity
      created
      description
      email
      externalId
    }
  }
}
updateCalendarBundle
Update calendar bundle.
Example
mutation UpdateCalendarBundle {
  updateCalendarBundle(input: { bundleId: 10, childrenIds: [10], organizationId: 10 }) {
    errorMessage
    success
    bundle {
      description
      id
      isPrivate
      name
    }
  }
}
updateCalendarGroup
Update calendar group.
Example
mutation UpdateCalendarGroup {
  updateCalendarGroup(input: { description: "<description>", groupId: 10, name: "<name>", organizationId: 10, slots: [{ calendarIds: [10], description: "<description>", name: "<name>", order: 10, requiredCount: 10 }] }) {
    errorMessage
    success
    group {
      created
      description
      id
      isPrivate
      modified
      name
    }
  }
}
updateResourceCalendar
Update resource calendar.
Example
mutation UpdateResourceCalendar {
  updateResourceCalendar(input: { calendarId: 10, organizationId: 10 }) {
    errorMessage
    success
    calendar {
      calendarType
      capacity
      created
      description
      email
      externalId
    }
  }
}
updateWebhookConfiguration
Update webhook configuration.
Example
mutation UpdateWebhookConfiguration {
  updateWebhookConfiguration(input: { id: 10 }) {
    errorMessage
    configuration {
      created
      eventType
      headers
      id
      modified
      url
    }
  }
}