Owners Mutation
Mutation enables to create or update owner in EverReal
Mutation Types
type Mutation {
upsertOwner(owner:OwnerInput!)
deleteOwner(externalId: String!)
}
Here are details on the capabilities of different mutations
The upsertOwner
mutation is used to create or update an owner in Everreal system and owners added to the system cannot be modified by Everreal and if needs to be modified it should be done via the same endpoint itself.The
deleteOwner
mutation is used to delete the owner relation with the external integration source, doing this will not delete the owner but instead it will remain as a detached owner from integration and can be modified using Everreal.
Schema Definition
items with ! notation are required
input OwnerInput {
meta: MetaInformation!
externalOwnerId: String! #externalId by which the owner is identified
firstName: String!
lastName: String!
companyName: String
email: String!
phoneNo: String
address: PersonalAddress
bankDepositInformation: BankDepositInformation
bankInformation: BankIformation
}
input PersonalAddress {
streetName: String
streetNumber: String
zipCode: String
city: String
country: String
}
input BankDepositInformation {
iban: String
bic: String
bankName: String
accountHolderName: String
}
input BankIformation {
bankName: String
bankAddress: String
bic: String
iban: String
}
input MetaInformation {
source: String! # source should be the integration source, so logo is visible in everreal
}
Below we are providing a full example how to create or update an owner, all this information is not required, only the ones that was using ! notation previously.
mutation {
upsertOwner(
owner: {
meta: { source: "INTEGRATION_SOURCE" }
externalOwnerId: "91001+002242"
firstName: "Ivana"
lastName: "Maric"
email: "[email protected]"
companyName: "Everreal Gmbh"
phoneNo: "+49 123 1231 1237"
address: {
streetName: "Villenallee"
streetNumber: "21"
zipCode: "40211"
city: "Düsseldorf"
country: "DE"
}
}
) {id}
}
Last updated
Was this helpful?