Skip to content
Home
Overview
Overview
Users
Overview
Overview
Fire
Overview
Overview
Water
Overview
Overview
Access
Overview
Overview
Energy
Overview
Overview
Misc
Overview
Overview
Other
Overview
Overview

Arguments

Return type

InstallerCreateOrganizationWithOwnerPayload
organizationId
ID
Mutation sample
mutation installerCreateOrganizationWithOwner($data: InstallerCreateOrganizationWithOwnerInput!) {
  installerCreateOrganizationWithOwner(data: $data) {
    organizationId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "organizationName": "Example String", "ownerEmail": "Example String" } }
Response sample
{ "data": { "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

organizationId
ID!,non-nullrequired
data
ProjectCreateInput!,non-nullrequired

Return type

InstallerOrganizationCreateProjectPayload
projectId
ID
Mutation sample
mutation installerOrganizationCreateProject($organizationId: ID!, $data: ProjectCreateInput!) {
  installerOrganizationCreateProject(organizationId: $organizationId, data: $data) {
    projectId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "location": { "country": "Example String", "city": "Example String", "street": "Example String", "postalCode": "Example String", "streetNumber": "Example String", "unitNumber": "Example String", "geoLocation": { "latitude": 40, "longitude": 40 }, "apartmentNumber": "Example String", "associationPk": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }, "buildingType": "APARTMENT", "constructionType": "CONCRETE", "buildingYear": 40, "projectNumber": "Example String", "sizeOfHousehold": 40, "buildingTitle": "Example String", "orderReferenceNumber": "Example String" } }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

Return type

InstallerOrganizationCreateProjectOnExistingHomePayload
projectId
ID
Mutation sample
mutation installerOrganizationCreateProjectOnExistingHome($data: OrganizationProjectOnExistingHomeCreateInput!) {
  installerOrganizationCreateProjectOnExistingHome(data: $data) {
    projectId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "organizationId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "orderReferenceNumber": "Example String", "buildingTitle": "Example String", "projectNumber": "Example String" } }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

Return type

ProjectOnExistingHomeCreatePayload
projectId
ID
errors
Mutation sample
mutation projectOnExistingHomeCreate($data: ProjectOnExistingHomeCreateInput!) {
  projectOnExistingHomeCreate(data: $data) {
    projectId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "installerId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "orderReferenceNumber": "Example String", "buildingTitle": "Example String", "projectNumber": "Example String" } }
Response sample
{ "data": { "projectId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

memberId
ID!,non-nullrequired

Return type

HomeMemberToggleEmergencyNotificationsPayload
memberId
ID!,non-null
Mutation sample
mutation homeMemberSetEmergencyNotifications($memberId: ID!, $data: HomeMemberSetEmergencyNotificationsInput!) {
  homeMemberSetEmergencyNotifications(memberId: $memberId, data: $data) {
    memberId 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "memberId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "enabled": true } }
Response sample
{ "data": { "memberId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

emergencyContactId
ID!,non-nullrequired

Return type

EmergencyContactDeletePayload
id
ID
Mutation sample
mutation emergencyContactDelete($emergencyContactId: ID!) {
  emergencyContactDelete(emergencyContactId: $emergencyContactId) {
    id 
    errors {
      message 
      path 
    }
  }
}
Variables
{ "emergencyContactId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4" }
Response sample
{ "data": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

homeId
ID!,non-nullrequired
data
EmergencyContactAddInput!,non-nullrequired

Return type

EmergencyContactAddPayload
emergencyContact
Mutation sample
mutation emergencyContactAdd($homeId: ID!, $data: EmergencyContactAddInput!) {
  emergencyContactAdd(homeId: $homeId, data: $data) {
    emergencyContact {
      id 
      firstName 
      lastName 
      phoneNumber {
        countryCode 
        nationalNumber 
      }
      isAlarmStationContact 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "homeId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "language": "Example String" } }
Response sample
{ "data": { "emergencyContact": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "isAlarmStationContact": true }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

emergencyContactId
ID!,non-nullrequired
data

Return type

EmergencyContactUpdatePayload
emergencyContact
Mutation sample
mutation emergencyContactUpdate($emergencyContactId: ID!, $data: EmergencyContactUpdateInput!) {
  emergencyContactUpdate(emergencyContactId: $emergencyContactId, data: $data) {
    emergencyContact {
      id 
      firstName 
      lastName 
      phoneNumber {
        countryCode 
        nationalNumber 
      }
      isAlarmStationContact 
    }
    errors {
      message 
      path 
    }
  }
}
Variables
{ "emergencyContactId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "firstName": "Example String", "lastName": "Example String" } }
Response sample
{ "data": { "emergencyContact": { "id": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "firstName": "Example String", "lastName": "Example String", "phoneNumber": { "countryCode": "Example String", "nationalNumber": "Example String" }, "isAlarmStationContact": true }, "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

userId
ID!,non-nullrequired
data

Return type

UpdateUserSubscriptionsPayload
Mutation sample
mutation updateUserSubscriptions($userId: ID!, $data: UpdateUserSubscriptionsInput!) {
  updateUserSubscriptions(userId: $userId, data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "userId": "9cfb1c81-4c79-452f-b1f5-8ee6571276b4", "data": { "subscriptions": [ { "subscriptionType": "ALARM_STATION", "tokens": 40 } ] } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

data

Return type

UserUpdatePreferencesPayload
Mutation sample
mutation userUpdatePreferences($data: UserUpdatePreferencesInput!) {
  userUpdatePreferences(data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "alarmPreferences": { "securityShowArmConfirmationModal": true }, "generalPreferences": { "betaVersion": true, "experimentalVersion": true } } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }

Arguments

data

Return type

UserUpdateNotificationPreferencesPayload
Mutation sample
mutation userUpdateNotificationPreferences($data: NotificationPreferencesInput!) {
  userUpdateNotificationPreferences(data: $data) {
    errors {
      message 
      path 
    }
  }
}
Variables
{ "data": { "notificationsEnabled": true } }
Response sample
{ "data": { "errors": [ { "message": "Example String", "path": "Example String" } ] } }
Overview
Overview
Overview
Overview
Overview
Overview