Overview
Queries
- Referrals
- Matters
Mutations
- Referrals
- Refinance
- Property Closings
- Status Certificate Review
Webhooks
- Event list
- Webhook subscriptions
Property closing referral create
Creates a new property closing referral.
mutation PropertyClosingReferralCreate($input: PropertyClosingReferralInput!) {
propertyClosingReferralCreate(input: $input) {
referral {
id
status
type
createdAt
primaryContact {
id
firstName
lastName
}
}
userErrors {
field
message
code
}
}
}
{
"data": {
"propertyClosingReferralCreate": {
"referral": {
"id": "gid://ownright/PurchasePropertyClosingReferral/456",
"status": "POTENTIAL",
"type": "PURCHASE_PROPERTY_CLOSING",
"createdAt": "2023-10-27T11:00:00Z",
"primaryContact": {
"id": "gid://ownright/ReferralContact/789",
"firstName": "Jane",
"lastName": "Smith"
}
},
"userErrors": []
}
}
}
mutation PropertyClosingReferralCreate($input: PropertyClosingReferralInput!) {
propertyClosingReferralCreate(input: $input) {
referral {
id
status
type
createdAt
primaryContact {
id
firstName
lastName
}
}
userErrors {
field
message
code
}
}
}
{
"data": {
"propertyClosingReferralCreate": {
"referral": {
"id": "gid://ownright/PurchasePropertyClosingReferral/456",
"status": "POTENTIAL",
"type": "PURCHASE_PROPERTY_CLOSING",
"createdAt": "2023-10-27T11:00:00Z",
"primaryContact": {
"id": "gid://ownright/ReferralContact/789",
"firstName": "Jane",
"lastName": "Smith"
}
},
"userErrors": []
}
}
}
Mutation field
propertyClosingReferralCreate
Arguments
Contacts to be associated with the referral.
The email for the referral contact.
The first name for the referral contact.
The last name for the referral contact.
The phone number for the referral contact. Required if prefers_to_be_phoned is true.
Whether the contact prefers to be phoned or not. If true, phone_number is required.
Whether this contact is the primary contact for the referral.
The address of the property the person is buying.
The city of the address.
The country of the address.
The postal code of the address.
The province of the address.
The street name and number of the address.
The unit number, suite number, apartment number, etc. of the address.
The address of the property the person is selling.
The type of the referral.
Return fields
The created referral.
The contacts for the referral.
The email of the contact.
The first name of the contact.
ID of the object.
Whether the contact is the primary contact.
The last name of the contact.
The phone number of the contact.
Whether the contact prefers to be phoned.
The time the referral was created.
ID of the object.
The primary contact for the referral.
The current status of the referral.
The type of the referral.
The time the referral was updated.
Types
enum Country {
CANADA # Represents Canada the country.
}
enum CurrencyCode {
CAD # Represents the CAD currency code.
USD # Represents the USD currency code.
}
enum CustomAttributeType {
BOOLEAN # A boolean value ("true" or "false").
COLOR # A hex color code starting with # (e.g., "#FF0000" or "#F00").
DATE # A date in ISO8601 format (YYYY-MM-DD, e.g., "2024-03-19").
DATE_TIME # A datetime in ISO8601 format with timezone (YYYY-MM-DDThh:mm:ssZ, e.g., "2024-03-19T12:00:00Z").
EMAIL # A valid email address (e.g., "[email protected]").
FLOAT # A decimal number value (e.g., "3.14").
INTEGER # A whole number value (e.g., "42").
JSON # A valid JSON value of any type.
MONEY # A money value as a JSON object with amount and currency code (e.g., {"amount": "10.99", "currency_code": "CAD"}).
PHONE_NUMBER # A valid E.164 phone number (e.g., "+1234567890").
STRING # A simple text value.
URL # A valid HTTP or HTTPS URL (e.g., "https://example.com").
}
enum PropertyClosingReferralCreateUserErrorCode {
FILE_RECORD_NOT_FOUND # One of the supplied file records could not be found.
FILE_RECORD_NOT_STAGED # One the supplied file records is not staged.
INVALID_REFERRAL_INPUT # The supplied referral input is invalid.
}
enum Province {
ALBERTA # Represents Alberta the province.
BRITISH_COLUMBIA # Represents British Columbia the province.
MANITOBA # Represents Manitoba the province.
NEWFOUNDLAND_AND_LABRADOR # Represents Newfoundland And Labrador the province.
NEW_BRUNSWICK # Represents New Brunswick the province.
NORTHWEST_TERRITORIES # Represents Northwest Territories the province.
NOVA_SCOTIA # Represents Nova Scotia the province.
NUNAVUT # Represents Nunavut the province.
ONTARIO # Represents Ontario the province.
PRINCE_EDWARD_ISLAND # Represents Prince Edward Island the province.
QUEBEC # Represents Quebec the province.
SASKATCHEWAN # Represents Saskatchewan the province.
YUKON # Represents Yukon the province.
}
enum ReferralStatus {
CONVERTED # Given to referrals that have been converted to a matter.
OPEN # Given to referrals that are currently open.
RETIRED # Given to referrals that are no longer being pursued.
}
enum ReferralType {
PURCHASE_PROPERTY_CLOSING # Represents a referral for a purchase property closing.
REFINANCE # Represents a referral for a refinance.
SALE_PROPERTY_CLOSING # Represents a referral for a sale property closing.
STATUS_CERTIFICATE_REVIEW # Represents a referral for a status certificate review.
}
scalar Decimal # A signed decimal number, which supports arbitrary precision and is serialized as a string.
scalar FileRecordGID # A global identifier for a FileRecord object in format of 'gid://ownright/FileRecord/ID'.
scalar GID # A global identifier for an object in the format of 'gid://ownright/ObjectType/ID'.
scalar ISO8601DateTime # An ISO 8601-encoded datetime
mutation PropertyClosingReferralCreate($input: PropertyClosingReferralInput!) {
propertyClosingReferralCreate(input: $input) {
referral {
id
status
type
createdAt
primaryContact {
id
firstName
lastName
}
}
userErrors {
field
message
code
}
}
}
{
"data": {
"propertyClosingReferralCreate": {
"referral": {
"id": "gid://ownright/PurchasePropertyClosingReferral/456",
"status": "POTENTIAL",
"type": "PURCHASE_PROPERTY_CLOSING",
"createdAt": "2023-10-27T11:00:00Z",
"primaryContact": {
"id": "gid://ownright/ReferralContact/789",
"firstName": "Jane",
"lastName": "Smith"
}
},
"userErrors": []
}
}
}