AM Logo
API AuthorizationAPI DocumentationForm DefinitionsFAQ
  1. Home
  3. API Documentation
  5. Outcomes
  7. Mutations

Mutations

List of available mutations.

activateApplicationRole (

roleId: UUID!,

): Boolean!
This mutation is used to activate an application role. **Returns:** Returns true if process was completed successfully
activateClient (

clientId: UUID!,

): Boolean!
This mutation is used to activate a client that has previously been inactivated. **Returns:** Returns the variable "true" if query ran successfully.
activateOrganizationalUnit (

organizationalUnitId: UUID!,

includeChildren: Boolean!,

): Boolean!
This mutation is used to activate an Organization Unit. **Returns:** Returns true if process was completed successfully.
activateOrganizationalUnitRole (

roleId: UUID!,

): Boolean!
This mutation is used to activate an organizational unit role. **Returns:** Returns true if process was completed successfully.
activateStaffMember (

staffMemberId: UUID!,

): Boolean!
This mutation is used to activate a staff member. **Returns:** Returns true if process was completed successfully.
addActivityLogEntry (

input: ActivityLogEntryInput!,

): ActivityLogEntry!
addApplicationLevelPermissions (

staffMemberId: UUID!,

permissions: ApplicationPermissionInput!,

): CasesManagementApplicationPermissionsSheet!
This mutation is used to add level permissions to an application. **Returns:** Returns applications permissions management permissions sheet with details such as, application permissions, client permissions and staff member permissions.
addApplicationLevelRolePermissions (

roleId: UUID!,

permissions: ApplicationPermissionInput!,

): CasesManagementApplicationPermissionsSheet!
This mutation is used to add level role permissions to an application. **Returns:** Returns applications permissions management permissions sheet with details such as, application permissions, client permissions and staff member permissions.
addCalendarEventAttendees (

wholeSeries: Boolean!,

id: UUID!,

attendeeKind: CalendarEventAttendeeKind!,

input: [CalendarEventAttendeeInput!]!,

): CalendarEvent!
This mutation is used to add an additional attendee to a calendar event. **Returns:** Returns calendar event details.
addCaseDocumentAspects (

caseDocumentId: UUID!,

aspectsIds: [UUID!]!,

): Boolean!
This mutation adds a case document to an aspect. **Returns:** Returns true if process was completed successfully.
addCaseFormSubmissionRequest (

caseId: UUID!,

caseFormSubmissionRequest: CaseFormSubmissionRequestInput!,

): CaseFormSubmissionRequest!
This mutation is used to add a new form submission request to a case for a specific tool/form. **Returns:** Returns the newly created Case Form Submission Request data.
addCaseFormSubmissionReview (

formSubmissionId: UUID!,

): CaseFormSubmissionReview!
Adds review for case form submission. **Returns:** Return added review.
addCaseFormSubmissionReviewComment (

threadId: UUID!,

comment: String!,

): CaseFormSubmissionReviewComment!
Adds a comment to case form review. **Returns:** Returns added comment.
addCaseFormSubmissionReviewCommentsThread (

reviewId: UUID!,

formElementId: String,

comment: String,

): CaseFormSubmissionReviewCommentsThread!
Adds a case form submission review comments thread. **Returns:** Returns review thread.
addCaseMetadata (

caseId: UUID!,

metadataEntryInput: MetadataEntryInput!,

): CaseMetadataEntry!
BACK END ONLY
addCaseNoteAspects (

caseNoteId: UUID!,

aspectsIds: [UUID!]!,

): Boolean!
This mutation adds a case note to multiple aspects. **Returns:** Returns true if process was completed successfully.
addClientAddresses (

clientId: UUID!,

addresses: [AddressInput!]!,

): [ClientAddress!]!
Adds addresses to a client. **Returns:** Returns list of added addresses.
addClientEmailAddresses (

clientId: UUID!,

emailAddresses: [String!]!,

): [ClientEmailAddress!]!
Adds email addresses to client. **Returns:** Returns added email addresses.
addClientExternalIdentifier (

clientId: UUID!,

name: String!,

value: String!,

): ClientExternalIdentifier!
Adds an external identifier for the client. **Returns:** Returns external identifier that was added.
addClientPhoneNumbers (

clientId: UUID!,

phoneNumbers: [String!]!,

): [ClientPhoneNumber!]!
Add phone numbers to client. **Returns:** Returns the list added phone numbers for client.
addDataFetchRequests (

formDefinitionVersionId: UUID!,

dataFetchRequests: [DataFetchRequestInput!]!,

): [DataFetchRequest!]!
addElements (

formDefinitionVersionId: UUID!,

elements: [ElementInput!]!,

): [Element!]!
addFormDefinitionVersion (

formDefinitionId: UUID!,

formDefinitionVersion: FormDefinitionVersionFullInput!,

): FormDefinitionVersion!
addImportCaptureGroup (

definitionId: UUID!,

captureGroup: ImportDefinitionCaptureGroupInput!,

): ImportDefinitionCaptureGroup!
addImportDataTransformation (

captureGroupId: UUID!,

transformation: ImportDefinitionCaptureGroupDataTransformationInput!,

): ImportDefinitionCaptureGroupDataTransformation!
addImportDefinitionArguments (

definitionId: UUID!,

arguments: [ImportDefinitionArgumentInput!]!,

): [ImportDefinitionArgument!]!
addImportJobSource (

jobId: UUID!,

jobSource: ImportJobSourceInput!,

): ImportJobSource!
addImportSource (

captureGroupId: UUID!,

source: ImportDefinitionSourceInput!,

): ImportDefinitionSource!
addImportTarget (

captureGroupId: UUID!,

target: ImportDefinitionTargetInput!,

): ImportDefinitionTarget!
addImportTargetExecutionCondition (

conditionsGroupId: UUID!,

condition: ImportDefinitionTargetExecutionConditionInput!,

): ImportDefinitionTargetExecutionCondition!
addImportTargetExecutionConditionsGroup (

targetId: UUID!,

conditionsGroup: ImportDefinitionTargetExecutionConditionsGroupInput!,

): ImportDefinitionTargetExecutionConditionsGroup!
addLookup (

lookup: LookupInput!,

lookupVersion: LookupVersionFullInput!,

): Lookup
addLookupValues (

lookupVersionId: UUID!,

values: [LookupValueInput!]!,

): [LookupValue!]!
addLookupVersion (

lookupId: UUID!,

lookupVersion: LookupVersionFullInput!,

): LookupVersion!
addOrganizationalUnitPermissions (

organizationalUnitId: UUID,

staffMemberId: UUID!,

permissions: OrganizationalUnitPermissionInput!,

): CasesManagementOrganizationalUnitPermissionsSheet!
This mutation is used to add permissions to an organizational unit. **Returns:** Returns case management application permission details such as, case permissions, organizational permissions and workflow permissions.
addOrganizationalUnitRolePermissions (

roleId: UUID!,

permissions: OrganizationalUnitPermissionInput!,

): CasesManagementOrganizationalUnitPermissionsSheet!
This mutation is used to add role permissions to an organizational unit. **Returns:** Returns case management application permission details such as, case permissions, organizational permissions and workflow permissions.
addScripts (

formDefinitionVersionId: UUID!,

scripts: [ScriptInput!]!,

): [Script!]!
addStaffMemberExternalIdentifier (

staffMemberId: UUID!,

externalIdentifier: StaffMemberExternalIdentifierInput!,

): StaffMemberExternalIdentifier!
Adds an external identifier for the staff member. **Returns:** Returns external identifier that was added.
addStatusValue (

statusId: UUID!,

statusValue: StatusValueInput!,

): StatusValue!
This mutation is used to create a new status value for a status. Return information will be exclusively related to the new status value. **Returns:** Returns the newly added status value data.
addVariables (

formDefinitionVersionId: UUID!,

variables: [VariableInput!]!,

): [Variable!]!
addWorkflowAutomation (

workflowId: UUID!,

automationInput: WorkflowAutomationInput!,

): WorkflowAutomation!
This mutation is used to create a new automation for a workflow. Return information can include automation actions, conditions, and trigger details along with information about the workflow. **Returns:** Returns the newly created automation data.
addWorkflowAutomationAction (

automationId: UUID!,

actionInput: WorkflowAutomationActionInput!,

): WorkflowAutomationAction!
This mutation is used to create a new action for an automation. Return information will be specific to the automation action details. **Returns:** Returns the newly created automation action data.
addWorkflowAutomationCondition (

conditionsGroupId: UUID!,

conditionInput: WorkflowAutomationConditionInput!,

): IWorkflowCondition!
This mutation is used to create a new condition for an automation. Return information will be specific to the automation condition details. **Returns:** Returns the newly created automation condition data.
addWorkflowAutomationConditionsGroup (

automationId: UUID!,

): WorkflowAutomationConditionsGroup!
This mutation is used to create a new condition group for an automation. Return information can include details about the condition group and the conditions. **Returns:** Returns the newly created automation conditions group data.
addWorkflowAutomationTrigger (

automationId: UUID!,

triggerInput: WorkflowAutomationTriggerInput!,

): WorkflowAutomationTrigger!
This mutation is used to create a new trigger for an automation. Return information will be specific to the automation trigger details. **Returns:** Returns the newly created automation trigger data.
addWorkflowCaseConfiguration (

workflowId: UUID!,

tenantId: UUID,

workflowCaseConfigurationInput: WorkflowCaseConfigurationInput!,

): WorkflowCaseConfiguration!
This mutation is used to create workflow case configuration. **Returns:** Return created workflow case configuration.
addWorkflowMetadata (

workflowId: UUID!,

metadataEntryInput: MetadataEntryInput!,

): WorkflowMetadataEntry!
This mutation is used to add new meta data to a workflow. **Returns:** Returns information will be related to the entered meta data.
addWorkflowScript (

workflowId: UUID!,

workflowScriptInput: WorkflowScriptInput!,

): WorkflowScript!
This mutation is used to create a new script for a workflow from scratch. Return will be specific to the newly added script. **Returns:** Returns the newly created workflow script data.
addWorkflowScriptFromFile (

workflowId: UUID!,

workflowScriptFileInput: WorkflowScriptFileInput!,

): WorkflowScript!
This mutation is used to create a new script for a workflow from an existing file. Return will be specific to the newly added script. **Returns:** Returns the newly created workflow script data.
addWorkflowUserInteraction (

workflowId: UUID!,

interactionInput: WorkflowUserInteractionInput!,

): WorkflowUserInteraction!
This mutation is used to create a new user interaction for a workflow. Return information will be specific to the newly created user interaction. **Returns:** Returns the newly created workflow user interaction data.
addWorkflowUserInteractionCondition (

conditionsGroupId: UUID!,

conditionInput: WorkflowUserInteractionConditionsInput!,

): IWorkflowCondition!
This mutation is used to add a new user interaction condition to a conditions group. Return information will be specific to the newly added conditions. **Returns:** Returns the newly added user interaction condition data.
addWorkflowUserInteractionConditionsGroup (

interactionId: UUID!,

): WorkflowUserInteractionConditionsGroup!
This mutation is used to add a new conditions group to an interaction. Return information will be specific to the newly added conditions group. **Returns:** Returns the newly added user interaction conditions group data.
assignApplicationRoles (

roleIds: [UUID!]!,

staffMemberIds: [UUID!]!,

): Boolean!
This mutation is used to assign application roles to staff members. This mutation can be used on multiple roles and multiple staff members. **Returns:** Returns the new role data, along with the staff members data
assignAspectToDocumentCategory (

documentCategoryId: UUID!,

aspectId: UUID!,

): Boolean!
Assigns an aspect to a document category. **Returns:** Returns true.
assignAspectToFormConfiguration (

formConfigurationId: UUID!,

aspectId: UUID!,

): Boolean!
This mutation is used to assign aspects to form configurations. **Returns:** Returns true if process was completed successfully.
assignAspectToReportConfiguration (

reportConfigurationId: UUID!,

aspectId: UUID!,

): Boolean!
This mutation is used to assign a report configuration to an aspect. **Returns:** Returns true if process was completed successfully.
assignCaseAspectOwnership (

caseId: UUID!,

aspectId: UUID!,

staffMemberId: UUID!,

): Case!
This mutation is used to assign the ownership of a case to another aspect. **Returns:** Return information included will relate to the associated case. Aspects, forms, organizational unit and workflow information can all be called in the return.
assignClientToOrganizationalUnit (

organizationalUnitId: UUID,

clientIds: [UUID!]!,

): Boolean!
This mutation allows you to assign an active client to an active organization using the client ID and Organization ID. **Returns:** Returns a boolean of "true" if the client is successfully added to the organization.
assignOrganizationalUnitRoles (

roleIds: [UUID!]!,

organizationalUnitIds: [UUID]!,

staffMemberIds: [UUID!]!,

): Boolean!
This mutation is used to assign organizational unit roles to staff members. This mutation can be used on multiple organizational unit roles and multiple staff members. **Returns:** Returns true if process was completed successfully.
assignPublicApiClientToOrganizationalUnit (

organizationalUnitId: UUID,

publicApiClientIds: [UUID!]!,

): Boolean!
Assigns a public api client to an organizational unit.
assignStaffMembersToOrganizationalUnit (

organizationalUnitId: UUID,

staffMemberIds: [UUID!]!,

): Boolean!
This mutation allows you to assign an active staff member to an active organization using the staff members ID and Organization ID. **Returns:** Returns a boolean of "true" if the staff member is successfully added to the organization.
assignStaffMemberToAspect (

organizationalUnitId: UUID,

staffMemberId: UUID!,

aspectId: UUID!,

): Boolean!
This mutation is used to assign aspects to staff members. This mutation can be used on multiple aspects and multiple staff members. **Returns:** Returns the new role data, along with the staff members data
assignWorkflowToOrganizationalUnit (

workflowId: UUID!,

tenantId: UUID!,

organizationalUnitId: UUID,

caseConfigurationInput: OrganizationalUnitWorkflowCaseConfigurationInput,

): Boolean!
This mutation is used to assign a workflow to an organizational unit. **Returns:** Returns true if process was completed successfully.
batchUpdateWorkflowAutomationConditions (

updates: [BatchWorkflowAutomationConditionUpdateInput!]!,

): Boolean!
cancelEmailMessage (

cancelMessage: CancelMessageInput!,

): Boolean!
cancelInAppMessage (

cancelMessage: CancelMessageInput!,

): Boolean!
cancelMergeClientsProcess (

processId: UUID!,

): Boolean!
cancelSmsMessage (

cancelMessage: CancelMessageInput!,

): Boolean!
changeApplicationRoleOwnership (

roleId: UUID!,

tenantId: UUID,

force: Boolean!,

): Boolean!
This mutation is used to change the ownership of a role to a different tenant. **Returns:** Returns the new role data, along with the tenants data
changeAutomationsState (

workflowId: UUID!,

isActive: Boolean!,

): Boolean!
Change state of all automations in workflow scope. **Returns:** true for success, throw exception if failed.
changeClientUserAccountPassword (

clientId: UUID!,

password: String!,

): Boolean!
Change user account password.
changeOrganizationalUnitRoleOwnership (

roleId: UUID!,

tenantId: UUID,

force: Boolean!,

): Boolean!
This mutation is used to change the ownership of a role to a different tenant. **Returns:** Returns true if process was completed successfully.
changePublicApiClientSecretKey (

apiClientId: UUID!,

secretKey: String!,

): PublicApiClient!
changeStaffMemberUserAccountPassword (

staffMemberId: UUID!,

password: String!,

): Boolean!
Change user account password.
changeUserInteractionsState (

workflowId: UUID!,

isActive: Boolean!,

): Boolean!
Change state of all user interactions in workflow state. **Returns:** true for success, throw exception if failed.
changeWorkflowOwnership (

workflowId: UUID!,

tenantId: UUID,

): Boolean!
This mutation is used to transfer ownership of a workflow from one tenant to another. **Returns:** Returns true if process was completed successfully.
clearApplicationLevelPermissions (

staffMemberId: UUID!,

): Boolean!
This mutation is used to clear level permissions from an application. **Returns:** Returns applications permissions management permissions sheet with details such as, application permissions, client permissions and staff member permissions.
clearApplicationLevelRolePermissions (

roleId: UUID!,

): Boolean!
This mutation is used to clear level role permissions from an application. **Returns:** Returns applications permissions management permissions sheet with details such as, application permissions, client permissions and staff member permissions.
clearCaseActionsAudits (

caseId: UUID!,

clearCaseActionsAuditInput: ClearCaseActionsAuditInput,

): Boolean!
This mutation is used to Clear Action Audits for Case **Returns:** Returns true if Case Action Audits are cleared.
clearCaseAspect (

caseId: UUID!,

aspectId: UUID!,

clearanceDate: DateTime!,

): Case!
This mutation is used to clear the case from an aspect. **Returns:** Return information included will relate to the associated case. Aspects, forms, organizational unit and workflow information can all be called in the return.
clearCaseAutomationErrors (

caseId: UUID!,

clearCaseAutomationErrorInput: ClearCaseAutomationErrorInput!,

): Boolean!
This mutation is used to Clear Automtation Errors for Case **Returns:** Returns true if Case Automation Errors are successfully cleared.
clearClientAddresses (

clientId: UUID!,

): Boolean!
Clears all client addresses. **Returns:** Returns true.
clearClientEmailAddresses (

clientId: UUID!,

): Boolean!
Clears all email addresses from a client. **Returns:** Returns true.
clearClientPhoneNumbers (

clientId: UUID!,

): Boolean!
Clears all client phone numbers. **Returns:** Returns true.
clearOrganizationalUnitPermissions (

organizationalUnitId: UUID,

staffMemberId: UUID!,

): Boolean!
This mutation is used to clear permissions from an organizational unit. **Returns:** Returns case management application permission details such as, case permissions, organizational permissions and workflow permissions.
clearOrganizationalUnitRolePermissions (

roleId: UUID!,

): Boolean!
This mutation is used to clear role permissions from an organizational unit. **Returns:** Returns case management application permission details such as, case permissions, organizational permissions and workflow permissions.
closeCase (

caseId: UUID!,

closeDate: DateTime,

): Case!
This mutation is used to close a case. **Returns:** Return information included will relate to the associated case. Aspects, forms, organizational unit and workflow information can all be called in the return.
closeCaseFormSubmissionRequest (

requestId: UUID!,

): Boolean!
This mutation is used to close a case form submission request. **Returns:** Returns the variable "true" if query ran successfully.
closeCaseFormSubmissionReviewCommentsThread (

threadId: UUID!,

): CaseFormSubmissionReviewCommentsThread!
Closes a case form submisison review thread. **Returns:** Returns closed thread.
copyApplicationRole (

roleInput: RoleInput!,

roleId: UUID!,

tenantId: UUID,

): ApplicationRole!
This mutation is used to copy the details of a single application role.The new application role will get a new distinct roleID. **Returns:** Returns the new role data.
copyOrganizationalUnitRole (

roleInput: RoleInput!,

roleId: UUID!,

tenantId: UUID,

): OrganizationalUnitRole!
BACK END ONLY
copyWorkflow (

workflowId: UUID!,

name: String!,

tenantId: UUID,

organizationalUnitId: UUID,

isDraft: Boolean!,

): Workflow!
This mutation is used to copy a workflow. **Returns:** Return information can include aspects, automations, reports, scripts and other related workflow details.
createApplicationRole (

roleInput: RoleInput!,

tenantId: UUID,

): ApplicationRole!
This mutation is used to create a new application role for a tenant. Return information can include new role details and tenant information. **Returns:** Returns the newly created role data.
createAspect (

workflowId: UUID!,

aspectInput: AspectInput!,

): Aspect!
This mutation is used to create a new aspect for a workflow. Return information can include new aspect details and workflow information. **Returns:** Returns the newly created aspect data.
createCalendarEvent (

calendarEvent: CalendarEventInput!,

): CalendarEventDefinition!
This mutation is used to create a new calendar events. Return information can include details about the newly created event. **Returns:** Returns newly created event details.
createCase (

case: CaseInput!,

): Case!
This mutation is used to create a new case. Return information can include aspects, forms, organizational unit and workflow information. **Returns:** Returns the newly created case data.
createCaseDocument (

caseId: UUID!,

caseDocument: CaseDocumentInput!,

): CaseDocument!
This mutation allows the user to create documents for a case. **Returns:** Returns newly created case documents details.
createCaseFormSubmission (

formConfigurationId: UUID!,

caseId: UUID!,

formDefinitionVersionId: UUID,

createDate: DateTime,

initialValues: AnswersSetValuesInput,

dataImport: Boolean,

): FormSubmission!
This mutation prepares a case for a form submission. **Returns:** Return information can include details about the specific case form submission.
createCaseNote (

caseId: UUID!,

caseNote: CaseNoteInput!,

aspectsIds: [UUID!]!,

): CaseNote!
This mutation is used to create a new case note for a case. Return information can include aspect details such as staff members and workflows. **Returns:** Returns the newly created case note data.
createClient (

client: ClientInput!,

demographics: DemographicsInput,

insurance: InsuranceInput,

tenantId: UUID,

organizationalUnitIds: [UUID],

externalIdentifiers: [ClientExternalIdentifierInput!],

): Client!
This mutation is used to create a new client, along with all demographics and insurance. **Returns:** Returns the newly created client information along with a new Client ID.
createClientForExistingUser (

userId: UUID,

username: String,

tenantId: UUID,

organizationalUnitIds: [UUID],

externalIdentifiers: [ClientExternalIdentifierInput!],

): Client!
This mutation is used to create a new client in QUALO that exists already exists in the QUALO Identity Server. This is internal use only and not yet implemented in UI. **Returns:** Returns the newly created client information along with a new Client ID.
createDocumentCategory (

workflowId: UUID!,

documentCategory: DocumentCategoryInput!,

): DocumentCategory!
Creates a document category. **Returns:** Returns created document category.
createFormConfiguration (

workflowId: UUID!,

formConfiguration: FormConfigurationInput!,

): FormConfiguration!
This mutation is used to create a new form configuration for a workflow. Return information can include Aspect, staff member and workflow details. **Returns:** Returns the newly created form configuration data.
createFormDefinition (

formDefinition: FormDefinitionInput!,

): FormDefinition!
createFormDefinitionVersion (

formDefinitionId: UUID!,

formDefinitionVersion: FormDefinitionVersionInput!,

): FormDefinitionVersion!
createImportDefinition (

definition: ImportDefinitionInput!,

): ImportDefinition!
createImporter (

input: ImporterInput!,

): Importer!
createImportJob (

job: ImportJobInput!,

): ImportJob!
createLookup (

lookup: LookupInput!,

): Lookup
createLookupVersion (

lookupId: UUID!,

lookupVersion: LookupVersionInput!,

): LookupVersion!
createOrganizationalUnit (

parentId: UUID,

organizationalUnit: OrganizationalUnitInput!,

tenantId: UUID,

address: OrganizationalUnitAddressInput,

emailAddress: String,

phoneNumber: String,

): OrganizationalUnit!
This mutation is used to create a new organizational unit for a tenant. Return information can include staff members, cases, children, reports, tenant information and other details about the organizational unit. **Returns:** Returns the newly created organizational unit data.
createOrganizationalUnitRole (

roleInput: RoleInput!,

tenantId: UUID,

): OrganizationalUnitRole!
This mutation is used to create a new organizational unit role for a tenant. Return information can include organizational unit role and staff member details. **Returns:** Returns the newly created organizational unit role data.
createPublicApiClient (

apiClient: PublicApiClientInput!,

): PublicApiClient!
createPublicApiClientAccessControlRule (

apiClientId: UUID!,

rule: AccessControlRuleInput!,

): PublicApiClientAccessControlRule!
createReportConfiguration (

workflowId: UUID!,

reportConfigurationInput: ReportConfigurationInput!,

): ReportConfiguration!
This mutation is used to create a new report configuration for a workflow. Return information can include aspect, report, workflow and other related report configuration details. **Returns:** Returns the newly created report configuration data.
createStaffMember (

staffMember: StaffMemberInput!,

tenantId: UUID,

organizationalUnitIds: [UUID],

): StaffMember!
This mutation is used to create a new staff member for a tenant. Return information can include permissions, staff member details, and organizational unit details. **Returns:** Returns the newly created staff member data.
createStaffMemberForExistingUser (

userId: UUID,

username: String,

tenantId: UUID,

organizationalUnitIds: [UUID],

): StaffMember!
This mutation is used to create a new staff member for a tenant using an already existing userID. Return information can include permissions, staff member details, and organizational unit details. **Returns:** Returns the newly updated staff member data.
createStatus (

workflowId: UUID!,

name: String!,

statusValues: [StatusValueInput!],

): Status!
This mutation is used to create a new status for a workflow. Return information can include workflow and status details. **Returns:** Returns the newly created status data.
createWorkflow (

tenantId: UUID,

workflow: WorkflowInput!,

): Workflow!
This mutation is used to create a new workflow for a tenant. Return information can include aspects, automations, reports, scripts and other related workflow details. **Returns:** Returns the newly created workflow data.
deactivateApplicationRole (

roleId: UUID!,

): Boolean!
This mutation is used to deactivate an application role. **Returns:** Returns true if process was completed successfully
deactivateClient (

clientId: UUID!,

): Boolean!
This mutation is used to mark a client inactive, with the prerequisite that the client does not have any active cases. **Returns:** Returns the variable "true" if query ran successfully.
deactivateOrganizationalUnit (

organizationalUnitId: UUID!,

): Boolean!
This mutation is used to deactivate an Organization Unit. **Returns:** Returns true if process was completed successfully.
deactivateOrganizationalUnitRole (

roleId: UUID!,

): Boolean!
This mutation is used to deactivate an organizational unit role. **Returns:** Returns true if process was completed successfully.
deactivateStaffMember (

staffMemberId: UUID!,

force: Boolean!,

): Boolean!
This mutation is used to deactivate a staff member. **Returns:** Returns true if process was completed successfully.
deleteAllFormSubmissions (

caseId: UUID!,

formConfigurationId: UUID,

deleteRequested: CaseFormSubmissionDeleteOperation!,

): Int!
BACK END ONLY - This mutation is used to delete all form submissions from a case.
deleteAnswersSetsOfFormDefinition (

formDefinitionId: UUID!,

): Boolean!
deleteAnswersSetsOfFormDefinitionVersion (

formDefinitionVersionId: UUID!,

): Boolean!
deleteApplicationRole (

roleId: UUID!,

force: Boolean!,

): Boolean!
This mutation is used to delete an application role. **Returns:** Returns true if process was completed successfully
deleteAspect (

aspectId: UUID!,

): Boolean!
This mutation is used to delete an aspect. **Returns:** Returns true if process was completed successfully.
deleteCase (

caseId: UUID!,

hardDelete: Boolean!,

): Boolean!
This mutation is used to delete a case. **Returns:** Returns true if process was completed successfully.
deleteCaseDocument (

caseDocumentId: UUID!,

): Boolean!
This mutation is used to delete a case document. **Returns:** Returns true if process was completed successfully.
deleteCaseFormSubmissionRequest (

requestId: UUID!,

): Boolean!
This mutation is used to delete a case form submission request. **Returns:** Returns the variable "true" if query ran successfully.
deleteCaseFormSubmissionReview (

reviewId: UUID!,

): Boolean!
Deletes a case form submission review. **Returns:** Returns true if delete was succesful.
deleteCaseFormSubmissionReviewComment (

commentId: UUID!,

): Boolean!
Deletes a comment from a case form review. **Returns:** Returns true if comment is succesfully deleted.
deleteCaseFormSubmissionReviewCommentsThread (

threadId: UUID!,

): Boolean!
Deleteds a case form submission review comments thread. **Returns:** Returns true if comment is deleted from thread.
deleteCaseNote (

caseNoteId: UUID!,

): Boolean!
This mutation is used to delete a case note. **Returns:** Returns true if process was completed successfully.
deleteClient (

clientId: UUID!,

): Boolean!
This mutation is used to delete a client, with the prerequisite that the client does not have any active cases. **Returns:** Returns the variable "true" if query ran successfully.
deleteFormDefinition (

formDefinitionId: UUID!,

hardDelete: Boolean!,

): Boolean!
deleteFormDefinitionVersion (

formDefinitionVersionId: UUID!,

hardDelete: Boolean!,

): Boolean!
deleteFormSubmission (

formSubmissionId: UUID!,

deleteRequested: CaseFormSubmissionDeleteOperation!,

): Boolean!
This mutation is used to delete a Form Submission. **Returns:** Returns true if process was completed successfully.
deleteImportDefinition (

definitionId: UUID!,

): Boolean!
deleteImporter (

id: UUID!,

): Boolean!
deleteImportJob (

jobId: UUID!,

): Boolean!
deleteLookup (

lookupId: UUID!,

hardDelete: Boolean!,

): Boolean!
deleteLookupVersion (

lookupVersionId: UUID!,

hardDelete: Boolean!,

): Boolean!
deleteNotification (

notificationId: UUID!,

): Boolean!
This mutation is used to delete notifications. **Returns:** Returns true if process was completed successfully.
deleteOrganizationalUnit (

organizationalUnitId: UUID!,

): Boolean!
This mutation is used to delete an Organizational Unit. **Returns:** Returns true if process was completed successfully.
deleteOrganizationalUnitRole (

roleId: UUID!,

force: Boolean!,

): Boolean!
This mutation is used to delete an organizational unit role. **Returns:** Returns true if process was completed successfully.
deletePublicApiClient (

apiClientId: UUID!,

): Boolean!
deleteStaffMember (

staffMemberId: UUID!,

force: Boolean!,

): Boolean!
This mutation is used to delete a staff member. **Returns:** Returns true if process was completed successfully.
deleteWorkflow (

workflowId: UUID!,

): Boolean!
This mutation is used to delete a workflow. **Returns:** Returns true if process was completed successfully.
duplicateFormDefinition (

formDefinitionId: UUID!,

keepAllVersions: Boolean!,

updateData: FormDefinitionInput,

): FormDefinition!
duplicateFormDefinitionVersion (

formDefinitionVersionId: UUID!,

updateData: FormDefinitionVersionInput,

): FormDefinitionVersion!
duplicateImportDefinition (

definitionId: UUID!,

definition: ImportDefinitionInput!,

): ImportDefinition!
duplicateLookup (

lookupId: UUID!,

keepAllVersions: Boolean!,

updateData: LookupInput,

): Lookup!
duplicateLookupVersion (

lookupVersionId: UUID!,

updateData: LookupVersionInput,

): LookupVersion!
finalizeFormSubmission (

formSubmissionId: UUID!,

): FormSubmission!
importFormDefinition (

file: FileDataInput!,

preview: Boolean!,

replaceExisting: Boolean!,

): FormDefinition!
importFormDefinitionVersion (

formDefinitionId: UUID!,

file: FileDataInput!,

preview: Boolean!,

replaceExisting: Boolean!,

): FormDefinitionVersion!
importLookup (

file: FileDataInput!,

preview: Boolean!,

replaceExisting: Boolean!,

): LookupExport!
importLookupVersion (

lookupId: UUID!,

file: FileDataInput!,

preview: Boolean!,

replaceExisting: Boolean!,

forceImport: Boolean!,

): LookupVersionExport!
liftPublicApiClientLockdown (

apiClientId: UUID!,

): PublicApiClient!
lockApplicationRole (

roleId: UUID!,

): Boolean!
This mutation is used to lock an application role. **Returns:** Returns true if process was completed successfully
lockdownPublicApiClient (

apiClientId: UUID!,

lockdownEnd: DateTime,

): PublicApiClient!
lockOrganizationalUnitRole (

roleId: UUID!,

): Boolean!
This mutation is used to lock an organizational unit role. **Returns:** Returns true if process was completed successfully.
markDeliveredInAppMessage (

markDeliveredMessage: MarkDeliveredMessageInput!,

): Boolean!
markNotificationsAsRead (

notificationIds: [UUID!]!,

): Boolean!
This mutation is used to change the status of a notification/s to read. **Returns:** Returns true if process was completed successfully.
mergeClients (

mergeClientsInput: ClientsMergeInput!,

): MergeClients!
moveImportCaptureGroup (

captureGroupId: UUID!,

newParentGroupId: UUID,

): Boolean!
moveOrganizationalUnit (

organizationalUnitId: UUID!,

newParentId: UUID,

): OrganizationalUnit!
This mutation is used to move an organizational unit to a new parent. Return information can include staff members, cases, children, reports, tenant information and other details about the organizational. **Returns:** Returns desired organizational unit information.
pauseImportJob (

jobId: UUID!,

): Boolean!
publishWorkflow (

workflowId: UUID!,

): Workflow!
This mutation is used to publish a workflow. **Returns:** Return information can include aspects, automations, reports, scripts and other related workflow details.
removeAllDataFetchRequests (

formDefinitionVersionId: UUID!,

): Boolean!
removeAllElements (

formDefinitionVersionId: UUID!,

): Boolean!
removeAllLookupValues (

lookupVersionId: UUID!,

): Boolean!
removeAllScripts (

formDefinitionVersionId: UUID!,

): Boolean!
removeAllVariables (

formDefinitionVersionId: UUID!,

): Boolean!
removeAnswersSetMetadata (

answersSetId: UUID!,

metadataIds: [String!]!,

): AnswersSet!
removeApplicationLevelPermissions (

staffMemberId: UUID!,

permissions: ApplicationPermissionInput!,

): CasesManagementApplicationPermissionsSheet!
This mutation is used to remove level permissions from an application. **Returns:** Returns applications permissions management permissions sheet with details such as, application permissions, client permissions and staff member permissions.
removeApplicationLevelRolePermissions (

roleId: UUID!,

permissions: ApplicationPermissionInput!,

): CasesManagementApplicationPermissionsSheet!
This mutation is used to remove level role permissions from an application. **Returns:** Returns applications permissions management permissions sheet with details such as, application permissions, client permissions and staff member permissions.
removeCalendarEvent (

wholeSeries: Boolean!,

id: UUID!,

): Boolean!
This mutation is used to remove a calendar event. **Returns:** Returns true if process was completed successfully
removeCalendarEventAttendees (

wholeSeries: Boolean!,

id: UUID!,

attendeeKind: CalendarEventAttendeeKind!,

usersIds: [UUID!]!,

): Boolean!
This mutation is used to remove an attendee from a calendar event.
removeCaseAspectOwnership (

caseId: UUID!,

aspectId: UUID!,

staffMemberId: UUID!,

): Case!
This mutation is used to remove the ownership of a case to another aspect. **Returns:** Return information included will relate to the associated case. Aspects, forms, organizational unit and workflow information can all be called in the return.
removeCaseDocumentAspects (

caseDocumentId: UUID!,

aspectsIds: [UUID!]!,

): Boolean!
This mutation removes a case document from an aspect. **Returns:** Returns true if process was completed successfully.
removeCaseMetadata (

caseId: UUID!,

key: String!,

): Boolean!
BACK END ONLY **Returns:** Returns true if process was completed successfully.
removeCaseNoteAspects (

caseNoteId: UUID!,

aspectsIds: [UUID!]!,

): Boolean!
This mutation removes a case note from multiple aspects. **Returns:** Returns true if process was completed successfully.
removeClientAddress (

clientId: UUID!,

addressId: UUID!,

): Boolean!
Removes an address from the client. **Returns:** Returns true.
removeClientEmailAddress (

clientId: UUID!,

emailAddressId: UUID!,

): Boolean!
Removes email address from a client.
removeClientExternalIdentifier (

externalId: UUID,

byName: ExternalIdInput,

): Boolean!
Removes a Client External Identifier. **Returns:** Returns true if successful.
removeClientPhoneNumber (

clientId: UUID!,

phoneNumberId: UUID!,

): Boolean!
Removes phone number from client. **Returns:** Returns true.
removeClientsFromOrganizationalUnit (

organizationalUnitId: UUID,

clientIds: [UUID!]!,

force: Boolean!,

): Boolean!
This mutation is used to remove clients from an organizational unit. **Returns:** Returns true if process was completed successfully.
removeDataFetchRequests (

formDefinitionVersionId: UUID!,

dataFetchRequestIds: [String!]!,

): Boolean!
removeDocumentCategory (

documentCategoryId: UUID!,

force: Boolean!,

): Boolean!
Removes a document category. **Returns:** Returns true.
removeElements (

formDefinitionVersionId: UUID!,

elementIds: [String!]!,

): Boolean!
removeFormConfiguration (

formConfigurationId: UUID!,

force: Boolean!,

): Boolean!
This mutation is used to remove or delete a form configuration. **Returns:** Returns true if process was completed successfully.
removeImportCaptureGroup (

captureGroupId: UUID!,

): Boolean!
removeImportDataTransformation (

transformationId: UUID!,

): Boolean!
removeImportDefinitionArguments (

argumentIds: [UUID!]!,

): Boolean!
removeImportJobSource (

jobSourceId: UUID!,

): Boolean!
removeImportSource (

sourceId: UUID!,

): Boolean!
removeImportTarget (

targetId: UUID!,

): Boolean!
removeImportTargetExecutionCondition (

conditionId: UUID!,

): Boolean!
removeImportTargetExecutionConditionsGroup (

conditionsGroupId: UUID!,

): Boolean!
removeLookupValues (

lookupVersionId: UUID!,

variableIds: [String!]!,

): Boolean!
removeOrganizationalUnitPermissions (

organizationalUnitId: UUID,

staffMemberId: UUID!,

permissions: OrganizationalUnitPermissionInput!,

): CasesManagementOrganizationalUnitPermissionsSheet!
This mutation is used to remove permissions from an organizational unit. **Returns:** Returns case management application permission details such as, case permissions, organizational permissions and workflow permissions.
removeOrganizationalUnitRolePermissions (

roleId: UUID!,

permissions: OrganizationalUnitPermissionInput!,

): CasesManagementOrganizationalUnitPermissionsSheet!
This mutation is used to remove role permissions from an organizational unit. **Returns:** Returns case management application permission details such as, case permissions, organizational permissions and workflow permissions.
removePublicApiClientAccessControlRule (

ruleId: UUID!,

): Boolean!
removeReportConfiguration (

reportConfigurationId: UUID!,

): Boolean!
This mutation is used to remove a report configuration. **Returns:** Returns true if process was completed successfully.
removeScripts (

formDefinitionVersionId: UUID!,

scriptIds: [String!]!,

): Boolean!
removeStaffMemberExternalIdentifier (

externalId: UUID!,

): Boolean!
Removes a Client External Identifier. **Returns:** Returns true if successful.
removeStaffMembersFromOrganizationalUnit (

organizationalUnitId: UUID,

staffMemberIds: [UUID!]!,

force: Boolean!,

): Boolean!
This mutation is used to remove staff members from an organizational unit. **Returns:** Returns true if process was completed successfully.
removeStatus (

statusId: UUID!,

): Boolean!
This mutation is used to remove a status. **Returns:** Returns true if process was completed successfully.
removeStatusValue (

statusValueId: UUID!,

): Boolean!
This mutation is used to remove a status value. **Returns:** Returns true if process was completed successfully.
removeVariables (

formDefinitionVersionId: UUID!,

variableIds: [String!]!,

): Boolean!
removeWorkflowAutomation (

automationId: UUID!,

): Boolean!
This mutation is used to activate an automation. **Returns:** Returns true if process was completed successfully.
removeWorkflowAutomationAction (

actionId: UUID!,

): Boolean!
This mutation is used to remove an automation action. **Returns:** Returns true if process was completed successfully.
removeWorkflowAutomationCondition (

conditionId: UUID!,

): Boolean!
This mutation is used to remove an automation condition. **Returns:** Returns true if process was completed successfully.
removeWorkflowAutomationConditionsGroup (

conditionsGroupId: UUID!,

): Boolean!
This mutation is used to remove an automation condition group. **Returns:** Returns true if process was completed successfully.
removeWorkflowAutomationTrigger (

triggerId: UUID!,

): Boolean!
This mutation is used to remove an automation trigger. **Returns:** Returns true if process was completed successfully.
removeWorkflowCaseConfiguration (

workflowCaseConfigurationId: UUID!,

): Boolean!
This mutation is used to delete workflow case configuration. **Returns:** bool
removeWorkflowMetadata (

workflowId: UUID!,

key: String!,

): Boolean!
This mutation is used to remove meta data from a workflow. **Returns:** Returns true if process was completed successfully.
removeWorkflowScript (

workflowScriptId: UUID!,

): Boolean!
This mutation is used to remove a script from a workflow. **Returns:** Returns true if process was completed successfully.
removeWorkflowUserInteraction (

interactionId: UUID!,

): Boolean!
This mutation is used to remove a workflow user interaction. **Returns:** Returns true if process was completed successfully
removeWorkflowUserInteractionCondition (

conditionId: UUID!,

): Boolean!
This mutation is used to remove a user interaction condition. **Returns:** Returns true if process was completed successfully.
removeWorkflowUserInteractionConditionsGroup (

conditionsGroupId: UUID!,

): Boolean!
This mutation is used to remove a interaction conditions group. **Returns:** Returns true if process was completed successfully.
reopenCase (

caseId: UUID!,

): Case!
This mutation is used to reopen a closed case. **Returns:** Return information included will relate to the associated case. Aspects, forms, organizational unit and workflow information can all be called in the return.
reopenCaseFormSubmissionReview (

reviewId: UUID!,

): CaseFormSubmissionReview!
Reopens case review. **Returns:** Returned reopened review.
reorderDocumentCategories (

workflowId: UUID!,

documentCategoryIds: [UUID!]!,

): [DocumentCategory!]!
Reorders document categories. **Returns:** Returns reordered document category ids.
reorderFormConfigurations (

workflowId: UUID!,

formConfigurationIds: [UUID!]!,

): [FormConfiguration!]!
This mutation is used to reorder the form configurations. **Returns:** Return information can include Aspect, staff member and workflow details.
reorderStatusValues (

statusId: UUID!,

statusOrderedValues: [UUID!]!,

): [StatusValue!]!
This mutation is used to reorder status values. **Returns:** Return information will be exclusively related to the new status value.
reorderWorkflowAutomation (

workflowId: UUID!,

automationIds: [UUID!]!,

): [WorkflowAutomation!]!
This mutation is used to reorder the automations. **Returns:** Return information can include automation actions, conditions, and trigger details along with information about the workflow.
reorderWorkflowAutomationAction (

automationId: UUID!,

automationActionIds: [UUID!]!,

): [WorkflowAutomationAction!]!
This mutation is used to reorder the automation actions. **Returns:** Return information can include automation actions, conditions, and trigger details along with information about the workflow.
reorderWorkflowUserInteraction (

workflowId: UUID!,

interactionIds: [UUID!]!,

): [WorkflowUserInteraction!]!
This mutation is used to reorder user interactions in a workflow. **Returns:** Return information can include details about the reordered user interactions.
replaceFormDefinitionVersion (

formDefinitionVersionId: UUID!,

updateData: FormDefinitionVersionFullInput!,

): FormDefinitionVersion!
replaceLookupVersion (

lookupVersionId: UUID!,

updateData: LookupVersionFullInput!,

): LookupVersion!
rescheduleCalendarRecurringEvent (

recurenceKey: UUID!,

input: CalendarEventRecurenceRescheduleInput!,

): CalendarEventDefinition!
This mutation is used to update the dates or rates of recurring calendar events. Return information can include details about the updated event and specific recurrence details. **Returns:** Returns the updated calendar event details and recurrence information.
resetClientUserAccountApplicationDeactivationDate (

clientId: UUID!,

recalculate: Boolean!,

): Boolean!
Change user account password.
resetClientUserAccountTenantDeactivationDate (

clientId: UUID!,

recalculate: Boolean!,

): Boolean!
Change user account password.
resetStaffMemberUserAccountApplicationDeactivationDate (

staffMemberId: UUID!,

recalculate: Boolean!,

): Boolean!
Reset user account tenant application deactivation date.
resetStaffMemberUserAccountTenantDeactivationDate (

staffMemberId: UUID!,

recalculate: Boolean!,

): Boolean!
Reset user account tenant deactivation date.
resolveCalendarEvent (

wholeSeries: Boolean!,

id: UUID!,

isResolved: Boolean,

resolutionCode: String,

): CalendarEvent!
This mutation is used to change the resolution of a single calendar event. Return information can include details about the updated event. **Returns:** Returns details of the resolved calendar event.
resolveCaseFormSubmissionReview (

reviewId: UUID!,

resolution: CaseFormSubmissionReviewResolution!,

): CaseFormSubmissionReview!
Resolves a case review. **Returns:** Returns resolved review.
resumeFailedAutomation (

automationErrorId: UUID!,

): Boolean!
resumeImportJob (

jobId: UUID!,

delay: TimeSpan,

): Boolean!
sendAutomationEvent (

sendAutomationEventInput: SendAutomationEventInput!,

): Boolean!
This mutation is used to send an Automation Event **Returns:** Returns true if the automation event is successfully sent
sendEmailMessage (

emailMessage: EmailMessageInput!,

): MessageInfo!
sendEmailMessageToClients (

clientEmailMessageInput: ClientEmailMessageInput!,

): EmailMessageToClients!
sendFormSubmissionToReview (

formSubmissionId: UUID!,

): CaseFormSubmission!
This mutation is used to finalize a Form Submission. **Returns:** Returns case form submission details with updated finalization status.
sendInAppMessage (

inAppMessage: InAppMessageInput!,

): MessageInfo!
sendSmsMessage (

smsMessage: SmsMessageInput!,

): MessageInfo!
sendSmsMessageToClients (

clientSmsMessageInput: ClientSmsMessageInput!,

): SmsMessageToClients!
setAnswersSetMetadata (

answersSetId: UUID!,

metadata: [IdValueInput!]!,

): AnswersSet!
setCaseExpectedClearanceDate (

caseId: UUID!,

aspectId: UUID!,

date: DateTime!,

): Case!
This mutation is used to set a cases expected clearance date. **Returns:** Return information included will relate to the associated case. Aspects, forms, organizational unit and workflow information can all be called in the return.
setCaseStatus (

caseId: UUID!,

statusValueIds: [UUID!]!,

): Boolean!
This mutation is used to set the status of an existing case. **Returns:** Returns true if process was completed successfully.
setTenantConfiguration (

configuration: TenantConfigurationInput!,

tenantId: UUID,

): TenantConfiguration!
Sets Tentnat Configuration **Returns:** Returns configuration that was set.
setUserNotificationsSettings (

userNotificationTypeSettings: [UserNotificationTypeSettingInput!]!,

userId: UUID,

tenantId: UUID,

): [UserNotificationTypeSetting!]!
This mutation is used to updated the settings of a users notifications. The return information will include information specific to the users notification settings. **Returns:** Returns the newly set notification settings.
startImportJob (

jobId: UUID!,

delay: TimeSpan,

): Boolean!
stopImportJob (

jobId: UUID!,

): Boolean!
submitPublicReference (

publicReferenceId: UUID!,

values: [AnswersSetValueInput!]!,

): PublicReference!
takeCaseAspectOwnership (

caseId: UUID!,

aspectId: UUID!,

): Case!
This mutation is used to transfer the ownership of a case to another aspect. **Returns:** Return information included will relate to the associated case. Aspects, forms, organizational unit and workflow information can all be called in the return.
unassignApplicationRoles (

roleIds: [UUID!]!,

staffMemberIds: [UUID!]!,

): Boolean!
This mutation is used to unassign application roles to staff members. This mutation can be used on multiple roles and multiple staff members. **Returns:** Returns the new role data, along with the staff members data
unassignAspectFromDocumentCategory (

documentCategoryId: UUID!,

aspectId: UUID!,

): Boolean!
Unassigns and aspect from a document category. **Returns:** Returns true.
unassignAspectFromFormConfiguration (

formConfigurationId: UUID!,

aspectId: UUID!,

): Boolean!
This mutation is used to unassign aspects to form configurations. **Returns:** Returns true if process was completed successfully.
unassignAspectFromReportConfiguration (

reportConfigurationId: UUID!,

aspectId: UUID!,

): Boolean!
This mutation is used to unassign a report configuration from an aspect. **Returns:** Returns true if process was completed successfully.
unassignOrganizationalUnitRoles (

roleIds: [UUID!]!,

organizationalUnitIds: [UUID]!,

staffMemberIds: [UUID!]!,

): Boolean!
This mutation is used to unassign organizational unit roles to staff members. This mutation can be used on multiple organizational unit roles and multiple staff members. **Returns:** Returns true if process was completed successfully.
unassignPublicApiClientToOrganizationalUnit (

organizationalUnitId: UUID,

publicApiClientIds: [UUID!]!,

): Boolean!
Unassigns pulblic api client identifiers from OrganizationalUnit.
unassignStaffMemberFromAspect (

organizationalUnitId: UUID,

staffMemberId: UUID!,

aspectId: UUID!,

force: Boolean!,

): Boolean!
This mutation is used to unassign aspects to staff members. This mutation can be used on multiple aspects and multiple staff members. **Returns:** Returns the new role data, along with the staff members data
unassignWorkflowFromOrganizationalUnit (

workflowId: UUID!,

tenantId: UUID!,

organizationalUnitId: UUID,

): Boolean!
This mutation is used to unassign a workflow from an organizational unit. **Returns:** Returns true if process was completed successfully.
undeleteApplicationRole (

roleId: UUID!,

): Boolean!
This mutation is used to undelete an application role. **Returns:** Returns true if process was completed successfully
undeleteCase (

caseId: UUID!,

): Boolean!
This mutation is used to undelete an application role. **Returns:** Returns true if process was completed successfully.
undeleteClient (

clientId: UUID!,

): Boolean!
This mutation is and internally used feature used to undelete a deleted client. **Returns:** Returns the variable "true" if query ran successfully.
undeleteFormDefinition (

formDefinitionId: UUID!,

): Boolean!
undeleteFormDefinitionVersion (

formDefinitionVersionId: UUID!,

): Boolean!
undeleteFormSubmission (

formSubmissionId: UUID!,

): Boolean!
This mutation is used to undelete a form submission. **Returns:** Returns true if process was completed successfully.
undeleteLookup (

lookupId: UUID!,

): Boolean!
undeleteLookupVersion (

lookupVersionId: UUID!,

): Boolean!
undeleteOrganizationalUnit (

organizationalUnitId: UUID!,

includeChildren: Boolean!,

): Boolean!
This mutation is used to undelete an Organizational Unit. **Returns:** Returns true if process was completed successfully.
undeleteOrganizationalUnitRole (

roleId: UUID!,

): Boolean!
This mutation is used to undelete an organizational unit role. **Returns:** Returns true if process was completed successfully.
undeleteStaffMember (

staffMemberId: UUID!,

): Boolean!
This mutation is used to undelete a staff member. **Returns:** Returns true if process was completed successfully.
undeleteWorkflow (

workflowId: UUID!,

): Boolean!
This mutation is used to undelete a workflow. **Returns:** Returns true if process was completed successfully.
unfinalizeFormSubmission (

formSubmissionId: UUID!,

): FormSubmission!
This mutation is used to unfinalize a Form Submission. **Returns:** Returns case form submission details with updated finalization status.
unlockApplicationRole (

roleId: UUID!,

): Boolean!
This mutation is used to unlock an application role. **Returns:** Returns true if process was completed successfully
unlockFormSubmission (

formSubmissionId: UUID!,

): Boolean!
unlockOrganizationalUnitRole (

roleId: UUID!,

): Boolean!
This mutation is used to unlock an organizational unit role. **Returns:** Returns true if process was completed successfully.
updateAnswersSetMetadata (

answersSetId: UUID!,

metadata: [UpdateInputOfIdValueInputAndIdValueInput!]!,

): AnswersSet!
updateApplicationRole (

roleInput: RoleInput!,

roleId: UUID!,

): ApplicationRole!
This mutation is used to update the details of a single application role.Return information can include new role details and tenant information. **Returns:** Returns the new role data.
updateAspect (

aspectId: UUID!,

aspectInput: AspectInput!,

): Aspect!
This mutation is used to update the details of a single aspect.Return information can include new aspect details and workflow information. **Returns:** Returns the new aspect data.
updateCalendarEventAttendees (

wholeSeries: Boolean!,

id: UUID!,

attendeeKind: CalendarEventAttendeeKind!,

input: [CalendarEventAttendeeInput!]!,

): CalendarEvent!
This mutation is used to update an attendee information for a calendar event. **Returns:** Returns calendar event details.
updateCalendarEventData (

wholeSeries: Boolean!,

id: UUID!,

input: CalendarEventDataInput!,

): CalendarEvent!
This mutation is used to update the details of a single calendar event. Return information can include details about the updated event. **Returns:** Returns the new updated event details.
updateCalendarEventDates (

id: UUID!,

input: CalendarEventDatesInput!,

): CalendarEvent!
This mutation is used to update the dates of a single calendar event. Return information can include details about the updated event. **Returns:** Returns the new updated event details.
updateCase (

caseId: UUID!,

case: CaseUpdateInput!,

): Case!
updateCaseDocument (

caseDocumentId: UUID!,

caseDocument: UpdateCaseDocumentInput!,

): CaseDocument!
updateCaseFormSubmissionRequest (

requestId: UUID!,

caseFormSubmissionRequest: CaseFormSubmissionRequestInput!,

): CaseFormSubmissionRequest!
This mutation is used to update an existing form submission request for a case for a specific tool/form. **Returns:** Returns the new Case Form Submission Request data.
updateCaseNote (

caseNoteId: UUID!,

caseNote: CaseNoteInput!,

): CaseNote!
This mutation is used to update the details of a single case note. Return information can include aspect details such as staff members and workflows. **Returns:** Returns the new updated case note details.
updateClient (

clientId: UUID!,

client: ClientInput!,

updateUser: Boolean!,

): Client!
This mutation is used to update identification information for an existing client. This includes full name, language and time zone. **Returns:** Returns the new client details for the updated client.
updateClientCommunication (

clientId: UUID!,

communication: CommunicationInput!,

): Communication
This mutation is used to update insurance information for an existing client. This includes insurance name and number. **Returns:** Returns the new client details for the updated client.
updateClientDemographics (

clientId: UUID!,

demographics: DemographicsInput!,

): Demographics!
This mutation is used to update demographic information for an existing client. This includes date of birth, ethnicity, gender, language and race. **Returns:** Returns the new client details for the updated client.
updateClientExternalIdentifier (

value: String!,

externalId: UUID,

byName: ExternalIdInput,

): ClientExternalIdentifier!
Update an external identifier for a client.
updateClientInsurance (

clientId: UUID!,

insurance: InsuranceInput,

): Insurance
This mutation is used to update insurance information for an existing client. This includes insurance name and number. **Returns:** Returns the new client details for the updated client.
updateDataFetchRequests (

formDefinitionVersionId: UUID!,

dataFetchRequests: [UpdateInputOfDataFetchRequestInputAndDataFetchRequestInput!]!,

): [DataFetchRequest!]!
updateDocumentCategory (

documentCategoryId: UUID!,

documentCategory: DocumentCategoryInput!,

): DocumentCategory!
Updates a document category. **Returns:** Returns updated coument category.
updateElements (

formDefinitionVersionId: UUID!,

elements: [UpdateInputOfElementInputAndElementInput!]!,

): [Element!]!
updateFormConfiguration (

formConfigurationId: UUID!,

formConfiguration: FormConfigurationInput!,

): FormConfiguration!
This mutation is used to update the details of a form configuration. Return information can include Aspect, staff member and workflow details. **Returns:** Returns the new updated form configuration details.
updateFormDefinition (

formDefinitionId: UUID!,

updateData: FormDefinitionInput!,

): FormDefinition!
updateFormDefinitionVersion (

formDefinitionVersionId: UUID!,

updateData: FormDefinitionVersionInput!,

): FormDefinitionVersion!
updateFormSubmission (

formSubmissionId: UUID!,

values: [AnswersSetValueInput!]!,

isFinal: Boolean!,

): FormSubmission!
This mutation is used to update the details of a single form submission. The return information will strictly be related to the specific updated case form submission. **Returns:** Returns case form submission details with updated finalization status.
updateImportCaptureGroup (

captureGroupId: UUID!,

captureGroup: ImportDefinitionCaptureGroupInput!,

): ImportDefinitionCaptureGroup!
updateImportDataTransformation (

transformationId: UUID!,

transformation: ImportDefinitionCaptureGroupDataTransformationInput!,

): ImportDefinitionCaptureGroupDataTransformation!
updateImportDefinition (

definitionId: UUID!,

definition: ImportDefinitionInput!,

): ImportDefinition!
updateImportDefinitionArguments (

arguments: [ImportDefinitionUpdateArgumentInput!]!,

): [ImportDefinitionArgument!]!
updateImportJob (

jobId: UUID!,

job: ImportJobInput!,

): ImportJob!
updateImportJobSource (

jobSourceId: UUID!,

jobSource: ImportJobSourceInput!,

): ImportJobSource!
updateImportSource (

sourceId: UUID!,

source: ImportDefinitionSourceInput!,

): ImportDefinitionSource!
updateImportTarget (

targetId: UUID!,

target: ImportDefinitionTargetInput!,

): ImportDefinitionTarget!
updateImportTargetExecutionCondition (

conditionId: UUID!,

condition: ImportDefinitionTargetExecutionConditionInput!,

): ImportDefinitionTargetExecutionCondition!
updateImportTargetExecutionConditionsGroup (

conditionsGroupId: UUID!,

conditionsGroup: ImportDefinitionTargetExecutionConditionsGroupInput!,

): ImportDefinitionTargetExecutionConditionsGroup!
updateLookup (

lookupId: UUID!,

updateData: LookupInput!,

): Lookup
updateLookupValues (

lookupVersionId: UUID!,

values: [UpdateInputOfLookupValueInputAndLookupValueInput!]!,

): [LookupValue!]!
updateLookupVersion (

lookupVersionId: UUID!,

updateData: LookupVersionInput!,

): LookupVersion!
updateOrganizationalUnit (

organizationalUnitId: UUID!,

organizationalUnit: OrganizationalUnitInput!,

): OrganizationalUnit!
This mutation is used to update the details of a single organizational unit. Return information can include staff members, cases, children, reports, tenant information and other details about the organizational unit. **Returns:** Returns the new updated organizational unit details.
updateOrganizationalUnitAddress (

organizationalUnitId: UUID!,

address: AddressInput!,

): OrganizationalUnitAddress!
This mutation is used to update the street address details of a single organizational unit. **Returns:** Returns the newly added address details.
updateOrganizationalUnitContact (

organizationalUnitId: UUID!,

emailAddress: String,

phoneNumber: String,

): Boolean!
This mutation is used to update the contact details of a single organizational unit such as email and phone. **Returns:** Returns true if process was completed successfully.
updateOrganizationalUnitRole (

roleInput: RoleInput!,

roleId: UUID!,

): OrganizationalUnitRole!
This mutation is used to update the details of a single organizational unit role. Return information can include organizational unit role and staff member details. **Returns:** Returns the new updated organizational unit role details.
updatePubliApiClientAccessControlRule (

ruleId: UUID!,

rule: AccessControlRuleInput!,

): PublicApiClientAccessControlRule!
updatePublicApiClient (

apiClientId: UUID!,

apiClient: PublicApiClientUpdateInput!,

): PublicApiClient!
updateReportConfiguration (

reportConfigurationId: UUID!,

reportConfigurationInput: ReportConfigurationInput!,

): ReportConfiguration!
This mutation is used to update the details of a single report configuration. Return information can include aspect, report, workflow and other related report configuration details. **Returns:** Returns the new report configuration details for the updated report configuration.
updateScripts (

formDefinitionVersionId: UUID!,

scripts: [UpdateInputOfScriptInputAndScriptInput!]!,

): [Script!]!
updateStaffMember (

staffMemberId: UUID!,

staffMember: StaffMemberInput!,

): StaffMember!
This mutation is used to update the details of a single staff member. Return information can include permissions, staff member details, and organizational unit details. **Returns:** Returns the new staff member details for the updated staff member.
updateStaffMemberExternalIdentifier (

externalId: UUID!,

externalIdentifier: StaffMemberExternalIdentifierInput!,

): StaffMemberExternalIdentifier!
Update an external identifier for a staff member. **Returns:** Returns external identifier that was updated.
updateStatus (

statusId: UUID!,

name: String!,

): Status!
This mutation is used to update the details of a single status. Return information can include workflow and status details. **Returns:** Returns the newly updated status data.
updateStatusValue (

statusValueId: UUID!,

statusValue: StatusValueInput!,

): StatusValue!
This mutation is used to update the details of a single status value. Return information will be exclusively related to the new status value. **Returns:** Returns the newly updated status value data.
updateVariables (

formDefinitionVersionId: UUID!,

variables: [UpdateInputOfVariableInputAndVariableInput!]!,

): [Variable!]!
updateWorkflow (

workflowId: UUID!,

workflow: WorkflowInput!,

): Workflow!
This mutation is used to update the details of a single workflow. Return information can include aspects, automations, reports, scripts and other related workflow details. **Returns:** Returns the newly updated workflow data.
updateWorkflowAutomation (

automationId: UUID!,

automationInput: WorkflowAutomationInput!,

): WorkflowAutomation!
This mutation is used to update the details of a single automation. Return information can include automation actions, conditions, and trigger details along with information about the workflow. **Returns:** Returns the newly updated automation data.
updateWorkflowAutomationAction (

actionId: UUID!,

actionInput: WorkflowAutomationActionInput!,

): WorkflowAutomationAction!
This mutation is used to update the details of a single automation action. Return information will be specific to the automation action details. **Returns:** Returns the newly updated automation action data.
updateWorkflowAutomationCondition (

conditionId: UUID!,

conditionInput: WorkflowAutomationConditionInput!,

): IWorkflowCondition!
This mutation is used to update the details of a single automation condition. Return information will be specific to the automation condition details. **Returns:** Returns the newly updated automation condition data.
updateWorkflowAutomationTrigger (

triggerId: UUID!,

triggerInput: WorkflowAutomationTriggerInput!,

): WorkflowAutomationTrigger!
This mutation is used to update the details of a single automation trigger. Return information will be specific to the automation trigger details. **Returns:** Returns the newly updated automation trigger data.
updateWorkflowCaseConfiguration (

workflowCaseConfigurationId: UUID!,

workflowCaseConfigurationInput: WorkflowCaseConfigurationInput!,

): WorkflowCaseConfiguration!
This mutation is used to update workflow case configuration. **Returns:** Return updated workflow case configuration.
updateWorkflowOrganizationalUnitCaseConfiguration (

workflowId: UUID!,

tenantId: UUID!,

organizationalUnitId: UUID,

caseConfigurationInput: OrganizationalUnitWorkflowCaseConfigurationInput!,

): Boolean!
This mutation is used to configure organizational unit case configuration.
updateWorkflowScript (

workflowScriptId: UUID!,

workflowScriptInput: WorkflowScriptInput!,

): WorkflowScript!
This mutation is used to update the details of a single workflow script. Return will be specific to the newly added script. **Returns:** Returns the newly updated workflow script data.
updateWorkflowScriptFromFile (

workflowScriptId: UUID!,

workflowScriptFileInput: WorkflowScriptFileInput!,

): WorkflowScript!
This mutation is used to update the details of a single workflow script using an existing file. Return will be specific to the newly added script. **Returns:** Returns the newly updated workflow script data.
updateWorkflowUserInteraction (

interactionId: UUID!,

interactionInput: WorkflowUserInteractionInput!,

): WorkflowUserInteraction!
This mutation is used to update the details of a single user interaction. Return information will be specific to the updated user interaction. **Returns:** Returns the updated workflow user interaction data.
updateWorkflowUserInteractionCondition (

conditionId: UUID!,

conditionInput: WorkflowUserInteractionConditionsInput!,

): IWorkflowCondition!
This mutation is used to update the details of a single condition. Return information will be specific to the updated conditions. **Returns:** Returns the newly updated user interaction condition data.
upsertClientByExternalId (

client: ClientInput!,

externalIdentifiers: [ClientExternalIdentifierInput!]!,

tenantId: UUID,

demographics: DemographicsInput,

insurance: InsuranceInput,

): Client!
This mutation checks if a client exists if client already exists then that client is updated otherwise a new client is created. **Returns:** Returns the newly created client information along with a new Client ID.
withdrawFormSubmissionFromReview (

formSubmissionId: UUID!,

): CaseFormSubmission!