PropertyManagerMutation.createProperty()

The response includes an identifier that can be used to reference the property.


Types

GraphQL
type PropertyManagerMutation {
  "Returns the normalized address of the property that was created"
  createProperty(input: PropertyManagerCreatePropertyInput!): PropertyManagerCreatePropertyResponse!
}

PropertyManagerCreatePropertyInput

input PropertyManagerCreatePropertyInput {
  address: PropertyManagerCreatePropertyAddressInput!
  resident: PropertyManagerCreatePropertyResidentInput
  externalId: String
}

address

PropertyManagerCreatePropertyAddressInput


resident

PropertyManagerCreatePropertyResidentInput | null


externalId

string | null This identifier is defined by the property owner. It can be used to identify the property in external systems. It will be included in order & invoice webhook payloads.

PropertyManagerCreatePropertyAddressInput

input PropertyManagerCreatePropertyAddressInput {
  line1: String!
  line2: String
  city: String!
  stateOrProvince: String!
  postalCode: String!
  country: String!
}

PropertyManagerCreatePropertyResidentInput

input PropertyManagerCreatePropertyResidentInput {
  name: String!
  email: String!
  phone: String!
}

PropertyManagerCreatePropertyResponse

GraphQL
type PropertyManagerCreatePropertyResponse {
  line1: String!
  line2: String
  city: String!
  stateOrProvince: String!
  postalCode: String!
  country: String!
}