Accounts Mutations

These mutations allow you to interact with accounts data.

addClientAddress

Returns: Client

Add an address to a client

Arguments

ArgumentTypeDescription
clientIdrequiredID!ID of the client (pet owner)
inputAddressInputInput data for address operation
Example Query
mutation(
$clientId: ID!,
$input: AddressInput
) {
addClientAddress(
clientId: $clientId,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"clientId": "1",
"input": {}
}

addClientStripeInfo

Returns: Client

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredPaymentSourceInput!Input
Example Query
mutation(
$id: ID!,
$input: PaymentSourceInput!
) {
addClientStripeInfo(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

addCoowner

Returns: Coowner

Add a coowner to a client

Arguments

ArgumentTypeDescription
clientIdrequiredID!ID of the client (pet owner)
inputrequiredCoownerInput!Input
Example Query
mutation(
$clientId: ID!,
$input: CoownerInput!
) {
addCoowner(
clientId: $clientId,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"clientId": "1",
"input": {}
}

createApiKey

Returns: ApiKey

Arguments

ArgumentTypeDescription
providerRoleIdrequiredID!Provider Role for API key
titlerequiredString!Title for API key
Example Query
mutation(
$providerRoleId: ID!,
$title: String!
) {
createApiKey(
providerRoleId: $providerRoleId,
title: $title
) {
id
# Add other fields you need
}
}
Variables
{
"providerRoleId": "1",
"title": "example"
}

createBridgeUser

Returns: Provider

Arguments

ArgumentTypeDescription
idrequiredID!Provider ID
Example Query
mutation($id: ID!) {
createBridgeUser(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

createClient

Returns: Client!

Arguments

ArgumentTypeDescription
inputClientInputAttributes of the client to be created
Example Query
mutation($input: ClientInput) {
createClient(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

createClientTag

Returns: ClientTag

Arguments

ArgumentTypeDescription
inputrequiredClientTagInput!Input
Example Query
mutation($input: ClientTagInput!) {
createClientTag(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

createProvider

Returns: Provider

Create a practitioner in your org if you are an admin

Arguments

ArgumentTypeDescription
inputrequiredProviderInput!Input
Example Query
mutation($input: ProviderInput!) {
createProvider(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

createProviderPin

Returns: Provider

Arguments

ArgumentTypeDescription
currentPasswordrequiredString!User's current password for verification
pinrequiredString!Pin
pinConfirmationrequiredString!Pin confirmation
Example Query
mutation(
$currentPassword: String!,
$pin: String!,
$pinConfirmation: String!
) {
createProviderPin(
currentPassword: $currentPassword,
pin: $pin,
pinConfirmation: $pinConfirmation
) {
id
# Add other fields you need
}
}
Variables
{
"currentPassword": "example",
"pin": "example",
"pinConfirmation": "example"
}

createProviderRole

Returns: ProviderRole!

Arguments

ArgumentTypeDescription
inputProviderRoleInputInput data for provider role operation
Example Query
mutation($input: ProviderRoleInput) {
createProviderRole(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

createRelationship

Returns: Relationship!

Arguments

ArgumentTypeDescription
inputRelationshipInputInput data for relationship operation
Example Query
mutation($input: RelationshipInput) {
createRelationship(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

deleteAddress

Returns: Address

Deletes an address under the client's info

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
Example Query
mutation($id: ID!) {
deleteAddress(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

deleteApiKey

Returns: ApiKey

Deletes an API key and associated API user

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
Example Query
mutation($id: ID!) {
deleteApiKey(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

deleteClientTag

Returns: ClientTag

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
Example Query
mutation($id: ID!) {
deleteClientTag(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

deleteCoowner

Returns: Coowner

Deletes an associate

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
Example Query
mutation($id: ID!) {
deleteCoowner(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

deleteProviderRole

Returns: ProviderRole!

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
Example Query
mutation($id: ID!) {
deleteProviderRole(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

deleteRelationship

Returns: Relationship!

Arguments

ArgumentTypeDescription
destinationRelationshipIdIDTarget relationship ID for transfer
idrequiredID!Unique identifier
Example Query
mutation(
$destinationRelationshipId: ID,
$id: ID!
) {
deleteRelationship(
destinationRelationshipId: $destinationRelationshipId,
id: $id
) {
id
# Add other fields you need
}
}
Variables
{
"destinationRelationshipId": "1",
"id": "1"
}

emailClientsAddresses

Returns: String

Arguments

ArgumentTypeDescription
insertedAtEndNaiveDateTimeInserted at end
insertedAtStartNaiveDateTimeInserted at start
locationIds[ID]List of location IDs
Example Query
mutation(
$insertedAtEnd: NaiveDateTime,
$insertedAtStart: NaiveDateTime,
$locationIds: [ID]
) {
emailClientsAddresses(
insertedAtEnd: $insertedAtEnd,
insertedAtStart: $insertedAtStart,
locationIds: $locationIds
) {
id
# Add other fields you need
}
}
Variables
{
"insertedAtEnd": {},
"insertedAtStart": {},
"locationIds": "1"
}

generateClientAuthToken

Returns: String

Arguments

ArgumentTypeDescription
clientIdrequiredID!ID of the client (pet owner)
Example Query
mutation($clientId: ID!) {
generateClientAuthToken(clientId: $clientId) {
id
# Add other fields you need
}
}
Variables
{
"clientId": "1"
}

mergeClients

Returns: Client

Arguments

ArgumentTypeDescription
fromIdrequiredID!ID of the from
toIdrequiredID!ID of the to
Example Query
mutation(
$fromId: ID!,
$toId: ID!
) {
mergeClients(
fromId: $fromId,
toId: $toId
) {
id
# Add other fields you need
}
}
Variables
{
"fromId": "1",
"toId": "1"
}

removeClientStripeInfo

Returns: String

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
Example Query
mutation($id: ID!) {
removeClientStripeInfo(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

resendVerification

Returns: String

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
Example Query
mutation($id: ID!) {
resendVerification(id: $id) {
id
# Add other fields you need
}
}
Variables
{
"id": "1"
}

resetProviderPin

Returns: Provider

Arguments

ArgumentTypeDescription
currentPasswordrequiredString!User's current password for verification
pinrequiredString!Pin
pinConfirmationrequiredString!Pin confirmation
Example Query
mutation(
$currentPassword: String!,
$pin: String!,
$pinConfirmation: String!
) {
resetProviderPin(
currentPassword: $currentPassword,
pin: $pin,
pinConfirmation: $pinConfirmation
) {
id
# Add other fields you need
}
}
Variables
{
"currentPassword": "example",
"pin": "example",
"pinConfirmation": "example"
}

saveProviderElectronicSignature

Returns: Provider

Arguments

ArgumentTypeDescription
providerIdrequiredID!ID of the provider
signaturerequiredString!Signature
Example Query
mutation(
$providerId: ID!,
$signature: String!
) {
saveProviderElectronicSignature(
providerId: $providerId,
signature: $signature
) {
id
# Add other fields you need
}
}
Variables
{
"providerId": "1",
"signature": "example"
}

sendEmailVerification

Returns: Client

Arguments

ArgumentTypeDescription
clientIdIDID of the client (pet owner)
isBillingEmailBooleanIs billing email
isSecondaryEmailBooleanIs secondary email
Example Query
mutation(
$clientId: ID,
$isBillingEmail: Boolean,
$isSecondaryEmail: Boolean
) {
sendEmailVerification(
clientId: $clientId,
isBillingEmail: $isBillingEmail,
isSecondaryEmail: $isSecondaryEmail
) {
id
# Add other fields you need
}
}
Variables
{
"clientId": "1",
"isBillingEmail": true,
"isSecondaryEmail": true
}

sendOutlookEmailVerification

Returns: Provider
Example Query
mutation {
sendOutlookEmailVerification {
id
# Add other fields you need
}
}

syncClient

Arguments

ArgumentTypeDescription
inputrequiredSyncClientInput!Input
Example Query
mutation($input: SyncClientInput!) {
syncClient(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

updateAddress

Returns: Address

Updates an address under the client's info

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredAddressInput!Input
Example Query
mutation(
$id: ID!,
$input: AddressInput!
) {
updateAddress(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updateClient

Returns: Client

Mutate a client if authorized

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredClientInput!Input
Example Query
mutation(
$id: ID!,
$input: ClientInput!
) {
updateClient(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updateClientExternalCommPreferences

Arguments

ArgumentTypeDescription
clientIdrequiredID!ID of the client (pet owner)
inputrequiredClientExternalCommPreferencesInput!Input
Example Query
mutation(
$clientId: ID!,
$input: ClientExternalCommPreferencesInput!
) {
updateClientExternalCommPreferences(
clientId: $clientId,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"clientId": "1",
"input": {}
}

updateClientTag

Returns: ClientTag

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredClientTagInput!Input
Example Query
mutation(
$id: ID!,
$input: ClientTagInput!
) {
updateClientTag(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updateCoowner

Returns: Coowner

Updates an associate

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredCoownerInput!Input
Example Query
mutation(
$id: ID!,
$input: CoownerInput!
) {
updateCoowner(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updatePhoneNumber

Returns: PhoneNumber

Mutate a phone number

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredPhoneNumberInput!Input
Example Query
mutation(
$id: ID!,
$input: PhoneNumberInput!
) {
updatePhoneNumber(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updateProvider

Returns: Provider

Mutate a provider only if you are an org admin

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredProviderInput!Input
Example Query
mutation(
$id: ID!,
$input: ProviderInput!
) {
updateProvider(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updateProviderRole

Returns: ProviderRole!

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputProviderRoleInputInput data for provider role operation
Example Query
mutation(
$id: ID!,
$input: ProviderRoleInput
) {
updateProviderRole(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updateRelationship

Returns: Relationship!

Arguments

ArgumentTypeDescription
idrequiredID!Unique identifier
inputrequiredRelationshipInput!Input
Example Query
mutation(
$id: ID!,
$input: RelationshipInput!
) {
updateRelationship(
id: $id,
input: $input
) {
id
# Add other fields you need
}
}
Variables
{
"id": "1",
"input": {}
}

updateViewer

Returns: Provider

Arguments

ArgumentTypeDescription
inputrequiredProviderViewerInput!Input
Example Query
mutation($input: ProviderViewerInput!) {
updateViewer(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

updateViewerPassword

Returns: Provider

Arguments

ArgumentTypeDescription
oldPasswordrequiredString!Old password
passwordrequiredString!Password
passwordConfirmationrequiredString!Password confirmation
Example Query
mutation(
$oldPassword: String!,
$password: String!,
$passwordConfirmation: String!
) {
updateViewerPassword(
oldPassword: $oldPassword,
password: $password,
passwordConfirmation: $passwordConfirmation
) {
id
# Add other fields you need
}
}
Variables
{
"oldPassword": "example",
"password": "example",
"passwordConfirmation": "example"
}

uploadProviderElectronicSignature

Returns: Provider

Arguments

ArgumentTypeDescription
providerIdrequiredID!ID of the provider
signaturerequiredUpload!Signature
Example Query
mutation(
$providerId: ID!,
$signature: Upload!
) {
uploadProviderElectronicSignature(
providerId: $providerId,
signature: $signature
) {
id
# Add other fields you need
}
}
Variables
{
"providerId": "1",
"signature": {}
}

uploadProviderProfileImage

Returns: Provider

Arguments

ArgumentTypeDescription
documentrequiredUpload!Document data or file
providerIdrequiredID!ID of the provider
Example Query
mutation(
$document: Upload!,
$providerId: ID!
) {
uploadProviderProfileImage(
document: $document,
providerId: $providerId
) {
id
# Add other fields you need
}
}
Variables
{
"document": {},
"providerId": "1"
}

upsertProviderAppointmentTypeLimit

Arguments

ArgumentTypeDescription
inputProviderAppointmentTypeLimitInputInput data for provider appointment type limit operation
Example Query
mutation($input: ProviderAppointmentTypeLimitInput) {
upsertProviderAppointmentTypeLimit(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

upsertProviderCommission

Arguments

ArgumentTypeDescription
inputProviderCommissionInputInput data for provider commission operation
Example Query
mutation($input: ProviderCommissionInput) {
upsertProviderCommission(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}

upsertProviderPreferences

Arguments

ArgumentTypeDescription
inputProviderPreferencesInputInput data for provider preferences operation
Example Query
mutation($input: ProviderPreferencesInput) {
upsertProviderPreferences(input: $input) {
id
# Add other fields you need
}
}
Variables
{
"input": {}
}