Entities Mutations

These mutations allow you to interact with entities data.

acquireFaxNumber

Arguments

Argument	Type	Description
`locationId`required	ID!	ID of the location

Example Query

mutation($locationId: ID!) {
  acquireFaxNumber(locationId: $locationId) {
    id
    # Add other fields you need
  }
}

Variables

{
  "locationId": "1"
}

acquireTollFreeNumber

Returns: Location

Arguments

Argument	Type	Description
`locationId`required	ID!	ID of the location

Example Query

mutation($locationId: ID!) {
  acquireTollFreeNumber(locationId: $locationId) {
    id
    # Add other fields you need
  }
}

Variables

{
  "locationId": "1"
}

acquireTwilioPhoneNumber

Returns: Location

Arguments

Argument	Type	Description
`areaCode`	String	Telephone area code
`locationId`required	ID!	ID of the location

Example Query

mutation(
  $areaCode: String,
  $locationId: ID!
) {
  acquireTwilioPhoneNumber(
    areaCode: $areaCode,
    locationId: $locationId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "areaCode": "example",
  "locationId": "1"
}

assignProviderToLocation

Returns: Provider

Assigns a provider to a location

Arguments

Argument	Type	Description
`locationId`required	ID!	ID of the location
`providerId`required	ID!	ID of the provider

Example Query

mutation(
  $locationId: ID!,
  $providerId: ID!
) {
  assignProviderToLocation(
    locationId: $locationId,
    providerId: $providerId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "locationId": "1",
  "providerId": "1"
}

batchUpsertOrgPreferences

Returns: [OrgPreference]

Batch create or update multiple org preferences in a single operation

Arguments

Argument	Type	Description
`preferences`required	[OrgPreferenceInput!]!	Preferences

Example Query

mutation($preferences: [OrgPreferenceInput!]!) {
  batchUpsertOrgPreferences(preferences: $preferences) {
    id
    # Add other fields you need
  }
}

Variables

{
  "preferences": {}
}

createAlert

Returns: Alert!

Arguments

Argument	Type	Description
`input`	AlertInput	Input data for alert operation

Example Query

mutation($input: AlertInput) {
  createAlert(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createCage

Returns: Cage!

Arguments

Argument	Type	Description
`input`	CageInput	Input data for cage operation

Example Query

mutation($input: CageInput) {
  createCage(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createClientRdvm

Returns: ClientRdvm!

Arguments

Argument	Type	Description
`input`	ClientRdvmInput	Input data for client rdvm operation

Example Query

mutation($input: ClientRdvmInput) {
  createClientRdvm(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createClientReferralSource

Returns: ClientReferralSource!

Arguments

Argument	Type	Description
`input`	ClientReferralSourceInput	Input data for client referral source operation

Example Query

mutation($input: ClientReferralSourceInput) {
  createClientReferralSource(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createConsentForm

Returns: ConsentForm!

Arguments

Argument	Type	Description
`input`	ConsentFormInput	Input data for consent form operation

Example Query

mutation($input: ConsentFormInput) {
  createConsentForm(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createCustomLocationAttribute

Returns: CustomLocationAttribute!

Arguments

Argument	Type	Description
`input`	CustomLocationAttributeInput	Input data for custom location attribute operation

Example Query

mutation($input: CustomLocationAttributeInput) {
  createCustomLocationAttribute(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createDepartment

Returns: Department!

Arguments

Argument	Type	Description
`input`	DepartmentInput	Input data for department operation

Example Query

mutation($input: DepartmentInput) {
  createDepartment(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createEntityValidation

Returns: EntityValidation!

Arguments

Argument	Type	Description
`input`	EntityValidationInput	Input data for entity validation operation

Example Query

mutation($input: EntityValidationInput) {
  createEntityValidation(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createLocation

Returns: Location

Example Query

mutation {
  createLocation {
    id
    # Add other fields you need
  }
}

createLocationAttribute

Returns: LocationAttribute!

Arguments

Argument	Type	Description
`input`	LocationAttributeInput	Input data for location attribute operation

Example Query

mutation($input: LocationAttributeInput) {
  createLocationAttribute(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createLocationTag

Returns: LocationTag!

Arguments

Argument	Type	Description
`input`	LocationTagInput	Input data for location tag operation

Example Query

mutation($input: LocationTagInput) {
  createLocationTag(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createOrgDepartment

Returns: OrgDepartment!

Arguments

Argument	Type	Description
`input`	OrgDepartmentInput	Input data for org department operation

Example Query

mutation($input: OrgDepartmentInput) {
  createOrgDepartment(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createOrgPreference

Returns: OrgPreference!

Arguments

Argument	Type	Description
`input`	OrgPreferenceInput	Input data for org preference operation

Example Query

mutation($input: OrgPreferenceInput) {
  createOrgPreference(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

createOutlookOrgPreference

Returns: OrgPreference

Arguments

Argument	Type	Description
`input`	OrgPreferenceInput	Input data for org preference operation

Example Query

mutation($input: OrgPreferenceInput) {
  createOutlookOrgPreference(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

deleteAlert

Returns: Alert!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteAlert(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteCage

Returns: Cage

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteCage(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteClientRdvm

Returns: ClientRdvm!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteClientRdvm(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteClientReferralSource

Returns: ClientReferralSource!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteClientReferralSource(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteConsentForm

Returns: ConsentForm!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteConsentForm(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteCustomLocationAttribute

Returns: CustomLocationAttribute!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteCustomLocationAttribute(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteDepartment

Returns: Department!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteDepartment(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteEntityValidation

Returns: EntityValidation!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteEntityValidation(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteLocation

Returns: Location

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteLocation(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteLocationTag

Returns: LocationTag!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier

Example Query

mutation($id: ID!) {
  deleteLocationTag(id: $id) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1"
}

deleteOrgDepartment

Returns: OrgDepartment!

Arguments

Argument	Type	Description
`destinationOrgDepartmentId`	ID	The ID of the OrgDepartment to which all location departments will be reassigned. If nil, the org_department must be the only one for its organization.
`id`required	ID!	Unique identifier

Example Query

mutation(
  $destinationOrgDepartmentId: ID,
  $id: ID!
) {
  deleteOrgDepartment(
    destinationOrgDepartmentId: $destinationOrgDepartmentId,
    id: $id
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "destinationOrgDepartmentId": "1",
  "id": "1"
}

fileDownloadLink

Returns: String!

Arguments

Argument	Type	Description
`path`required	String!	Path

Example Query

mutation($path: String!) {
  fileDownloadLink(path: $path) {
    id
    # Add other fields you need
  }
}

Variables

{
  "path": "example"
}

mergeClientReferralSources

Returns: [ClientReferralSource]

Arguments

Argument	Type	Description
`fromId`required	ID!	ID of the from
`toId`required	ID!	ID of the to

Example Query

mutation(
  $fromId: ID!,
  $toId: ID!
) {
  mergeClientReferralSources(
    fromId: $fromId,
    toId: $toId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "fromId": "1",
  "toId": "1"
}

reorderAlerts

Returns: [Alert]

Arguments

Argument	Type	Description
`fromId`required	ID!	ID of the from
`toId`required	ID!	ID of the to

Example Query

mutation(
  $fromId: ID!,
  $toId: ID!
) {
  reorderAlerts(
    fromId: $fromId,
    toId: $toId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "fromId": "1",
  "toId": "1"
}

reorderClientReferralSources

Returns: [ClientReferralSource]

Arguments

Argument	Type	Description
`fromId`required	ID!	ID of the from
`toId`required	ID!	ID of the to

Example Query

mutation(
  $fromId: ID!,
  $toId: ID!
) {
  reorderClientReferralSources(
    fromId: $fromId,
    toId: $toId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "fromId": "1",
  "toId": "1"
}

sendLocationChatMessage

Returns: LocationChatMessage

Arguments

Argument	Type	Description
`body`	String	Main content or message body
`locationId`required	ID!	ID of the location

Example Query

mutation(
  $body: String,
  $locationId: ID!
) {
  sendLocationChatMessage(
    body: $body,
    locationId: $locationId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "body": "example",
  "locationId": "1"
}

setChatLastReadAt

Returns: String

Arguments

Argument	Type	Description
`locationId`required	ID!	ID of the location

Example Query

mutation($locationId: ID!) {
  setChatLastReadAt(locationId: $locationId) {
    id
    # Add other fields you need
  }
}

Variables

{
  "locationId": "1"
}

setDaycareOpen

Returns: Boolean

Arguments

Argument	Type	Description
`date`required	Date!	Specific date for the query
`locationId`required	ID!	ID of the location
`value`required	Boolean!	Value

Example Query

mutation(
  $date: Date!,
  $locationId: ID!,
  $value: Boolean!
) {
  setDaycareOpen(
    date: $date,
    locationId: $locationId,
    value: $value
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "date": {},
  "locationId": "1",
  "value": true
}

unassignProviderFromLocation

Returns: Provider

Removes a provider from a location

Arguments

Argument	Type	Description
`locationId`required	ID!	ID of the location
`providerId`required	ID!	ID of the provider

Example Query

mutation(
  $locationId: ID!,
  $providerId: ID!
) {
  unassignProviderFromLocation(
    locationId: $locationId,
    providerId: $providerId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "locationId": "1",
  "providerId": "1"
}

updateAlert

Returns: Alert

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	AlertInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: AlertInput!
) {
  updateAlert(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateCage

Returns: Cage

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	CageInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: CageInput!
) {
  updateCage(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateClientRdvm

Returns: ClientRdvm

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	ClientRdvmInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: ClientRdvmInput!
) {
  updateClientRdvm(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateClientReferralSource

Returns: ClientReferralSource

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	ClientReferralSourceInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: ClientReferralSourceInput!
) {
  updateClientReferralSource(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateConsentForm

Returns: ConsentForm

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	ConsentFormInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: ConsentFormInput!
) {
  updateConsentForm(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateCustomLocationAttribute

Returns: CustomLocationAttribute

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	CustomLocationAttributeInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: CustomLocationAttributeInput!
) {
  updateCustomLocationAttribute(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateDepartment

Returns: Department!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	DepartmentInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: DepartmentInput!
) {
  updateDepartment(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateEntityValidation

Returns: EntityValidation

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	EntityValidationInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: EntityValidationInput!
) {
  updateEntityValidation(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateLocation

Returns: Location

Updates a location

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`	LocationInput	Input data for location operation

Example Query

mutation(
  $id: ID!,
  $input: LocationInput
) {
  updateLocation(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateLocationAttribute

Returns: LocationAttribute

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	LocationAttributeInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: LocationAttributeInput!
) {
  updateLocationAttribute(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateLocationTag

Returns: LocationTag

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	LocationTagInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: LocationTagInput!
) {
  updateLocationTag(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateOrg

Returns: Org

Update the viewer's org if the provider is an org admin

Arguments

Argument	Type	Description
`input`	OrgInput	Input data for org operation

Example Query

mutation($input: OrgInput) {
  updateOrg(input: $input) {
    id
    # Add other fields you need
  }
}

Variables

{
  "input": {}
}

updateOrgDepartment

Returns: OrgDepartment!

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	OrgDepartmentInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: OrgDepartmentInput!
) {
  updateOrgDepartment(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateOrgPreference

Returns: OrgPreference

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`required	OrgPreferenceInput!	Input

Example Query

mutation(
  $id: ID!,
  $input: OrgPreferenceInput!
) {
  updateOrgPreference(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

updateOutlookOrgPreference

Returns: OrgPreference

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`input`	OrgPreferenceInput	Input data for org preference operation

Example Query

mutation(
  $id: ID!,
  $input: OrgPreferenceInput
) {
  updateOutlookOrgPreference(
    id: $id,
    input: $input
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "input": {}
}

uploadClinicImage

Returns: Location

Arguments

Argument	Type	Description
`clinicImage`required	Upload!	Clinic logo or branding image
`locationId`required	ID!	ID of the location

Example Query

mutation(
  $clinicImage: Upload!,
  $locationId: ID!
) {
  uploadClinicImage(
    clinicImage: $clinicImage,
    locationId: $locationId
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "clinicImage": {},
  "locationId": "1"
}

uploadLocationLogo

Returns: Org

Arguments

Argument	Type	Description
`id`required	ID!	Unique identifier
`logo`required	Upload!	Logo

Example Query

mutation(
  $id: ID!,
  $logo: Upload!
) {
  uploadLocationLogo(
    id: $id,
    logo: $logo
  ) {
    id
    # Add other fields you need
  }
}

Variables

{
  "id": "1",
  "logo": {}
}

uploadOrgLogo

Returns: Org

Arguments

Argument	Type	Description
`logo`required	Upload!	Logo

Example Query

mutation($logo: Upload!) {
  uploadOrgLogo(logo: $logo) {
    id
    # Add other fields you need
  }
}

Variables

{
  "logo": {}
}