Mutation

Definition of the Mutation object

Fields

Name	Arguments	Type	Description	Required Scope
abandonCase	caseId: String!	UpdateCaseResult	Marks a case as abandoned	case-management
activateEntityProfile	input: ActivateEntityProfileInput!	ActivateEntityProfileResult!	Marks the current profile of an entity as active	profile-management
activateIndividualProfile	input: ActivateIndividualProfileInput!	ActivateIndividualProfileResult!	Marks the current profile of an individual as active	profile-management
addCaseAssignees	input: AddCaseAssigneesInput!	UpdateCaseResult!	Assigns users to an existing case, keeping its current assignees. The case must be open: Draft, In Progress, On Hold, Ready For Review or Dormant.	case-management
addCaseNote	input: AddCaseNoteInput!	UpdateCaseResult	Add new note to case	case-management
addEntityDocumentFile	input: AddEntityDocumentFileInput!	AddEntityFileResult	Add a file to an entity document	case-management
addExceptionForCaseEntity	input: AddExceptionForCaseEntityInput!	UpdateCaseResult	Add an exception for an entity for a specific case	case-management
addExceptionForCaseIndividual	input: AddExceptionForCaseIndividualInput!	UpdateCaseResult	Add an exception for an individual for a specific case	case-management
addExistingIndividualsToCase	input: AddExistingIndividualsToCaseInput!	UpdateCaseResult	Add one or more additional existing individuals to an existing case that require verification	case-management
addIndividualDocumentFile	input: AddIndividualDocumentFileInput!	AddFileResult	Add a file to an individual document	case-management
addIndividualsToCase	input: AddIndividualsToCaseInput!	UpdateCaseResult	Add one or more additional individuals to an existing case that require verification	case-management
addWebhookSubscriptionTarget	input: AddWebhookTargetInput!	WebhookResult!		api-management
completeCase	caseId: String!	UpdateCaseResult	Marks a case that is in progress or ready for review as complete	case-management
createCase	input: CreateCaseInput!	CreateCaseResult!	Create a new case	case-management
createCasePdf	input: GeneratePdfInput!	GeneratedPdfInformation!		case-management
createEntityDocument	input: AddEntityDocumentInput!	AddEntityDocumentResult	Add an entity document	case-management
createIndividualDocument	input: AddIndividualDocumentInput!	AddIndividualDocumentResult	Add a document to an individual	case-management
createWebhookSubscription	input: CreateWebhookInput!	WebhookResult!		api-management
deactivateEntityProfile	input: DeactivateEntityProfileInput!	DeactivateEntityProfileResult!	Marks the current profile of an entity as inactive. Ongoing monitoring of the profile is turned off	profile-management
deactivateIndividualProfile	input: DeactivateIndividualProfileInput!	DeactivateIndividualProfileResult!	Marks the current profile of an individual as inactive. Ongoing monitoring of the profile is turned off	profile-management
deleteEntityDocument	input: DeleteEntityDocumentInput!	DeleteEntityDocumentResult	Delete an entity document	case-management
deleteEntityDocumentFile	input: DeleteEntityDocumentFileInput!	DeleteEntityDocumentFileResult	Delete an entity document file	case-management
deleteExceptionForCaseEntity	input: DeleteExceptionForCaseEntityInput!	UpdateCaseResult	Delete an exception for an entity for a specific case	case-management
deleteExceptionForCaseIndividual	input: DeleteExceptionForCaseIndividualInput!	UpdateCaseResult	Delete an exception for an individual for a specific case	case-management
deleteIndividualDocument	input: DeleteIndividualDocumentInput!	DeleteIndividualDocumentResult	Delete an individual document	case-management
deleteIndividualDocumentFile	input: DeleteIndividualDocumentFileInput!	DeleteIndividualDocumentFileResult	Delete an individual document file	case-management
deleteWebhookSubscription	input: DeleteWebhookInput!	WebhookResult!		api-management
disableEntityProfileMonitoring	input: DisableEntityProfileMonitoringInput!	DisableEntityProfileMonitoringResult!	Turns off ongoing monitoring for the current profile of an entity	profile-management
disableIndividualProfileMonitoring	input: DisableIndividualProfileMonitoringInput!	DisableIndividualProfileMonitoringResult!	Turns off ongoing monitoring for the current profile of an individual	profile-management
enableEntityProfileMonitoring	input: EnableEntityProfileMonitoringInput!	EnableEntityProfileMonitoringResult!	Turns on ongoing monitoring for the current profile of an entity	profile-management
enableIndividualProfileMonitoring	input: EnableIndividualProfileMonitoringInput!	EnableIndividualProfileMonitoringResult!	Turns on ongoing monitoring for the current profile of an individual	profile-management
removeCaseAssignees	input: RemoveCaseAssigneesInput!	UpdateCaseResult!	Unassigns users from an existing case, keeping its other assignees. The case must be open: Draft, In Progress, On Hold, Ready For Review or Dormant.	case-management
removeWebhookSubscriptionTarget	input: RemoveWebhookTargetInput!	WebhookResult!		api-management
reworkCase	caseId: String!	UpdateCaseResult	Reworks a completed case and moves it’s status back to in progress	case-management
runVerificationChecks	input: RunVerificationChecksInput!	RunVerificationChecksResult!		case-management
submitCase	caseId: String!	UpdateCaseResult	Submits a draft case and move it’s status to in progress	case-management
updateCaseName	input: UpdateCaseNameInput!	UpdateCaseResult	Update the name for an existing case	case-management
updateCaseReference	input: UpdateCaseReferenceInput!	UpdateCaseResult	Update the client-assigned reference for an existing case	case-management
updateEntity	input: UpdateEntityInput!	UpdateCaseResult	Updates the details of an entity on a case	case-management
updateExceptionForCaseEntity	input: UpdateExceptionForCaseEntityInput!	UpdateCaseResult	Update an exception for an entity for a specific case	case-management
updateExceptionForCaseIndividual	input: UpdateExceptionForCaseIndividualInput!	UpdateCaseResult	Update an exception for an individual for a specific case	case-management
updateIndividual	input: UpdateIndividualInput!	UpdateCaseResult	Updates the details of an individual on a case	case-management

---