Property Closing Referral Create

mutation PropertyClosingReferralCreate($input: PropertyClosingReferralInput!) {
  propertyClosingReferralCreate(input: $input) {
    referral {
      createdAt
      id
      status
      type
      updatedAt
      contacts {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      customAttributes {
        id
        key
        type
        value
      }
      primaryContact {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      ... on PurchasePropertyClosingReferral {
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
        purchaseAmount {
          amount
          currencyCode
        }
      }
      ... on RefinanceReferral {
        mortgageAmount {
          amount
          currencyCode
        }
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
      ... on SalePropertyClosingReferral {
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

{
  "input": {
    "contacts": [
      {
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Doe",
        "phoneNumber": "+14165551234",
        "primary": true
      }
    ],
    "customAttributes": [
      {
        "key": "example-key",
        "type": "BOOLEAN",
        "value": "example-value"
      }
    ],
    "files": [
      {
        "fileRecordId": "gid://ownright/FileRecord/1",
        "tags": [
          "example-tags"
        ]
      }
    ],
    "intentLevel": "HIGH",
    "purchaseAmount": {
      "amount": "100.00",
      "currencyCode": "CAD"
    },
    "purchasePropertyAddress": {
      "city": "Toronto",
      "country": "CANADA",
      "postalCode": "M5V 1A1",
      "province": "ALBERTA",
      "street": "123 Main St",
      "unitNumber": "Suite 100"
    },
    "salePropertyAddress": {
      "city": "Toronto",
      "country": "CANADA",
      "postalCode": "M5V 1A1",
      "province": "ALBERTA",
      "street": "123 Main St",
      "unitNumber": "Suite 100"
    },
    "type": "PURCHASE_PROPERTY_CLOSING"
  }
}

{
  "data": {
    "propertyClosingReferralCreate": {
      "referral": {
        "createdAt": "2025-01-15T10:30:00Z",
        "id": "gid://ownright/Object/1",
        "status": "CONVERTED",
        "type": "PURCHASE_PROPERTY_CLOSING",
        "updatedAt": "2025-01-15T10:30:00Z",
        "contacts": [
          {
            "email": "[email protected]",
            "firstName": "Jane",
            "id": "gid://ownright/Object/1",
            "isPrimary": true,
            "lastName": "Doe",
            "phoneNumber": "+14165551234"
          }
        ],
        "customAttributes": [
          {
            "id": "gid://ownright/Object/1",
            "key": "example-key",
            "type": "BOOLEAN",
            "value": "example-value"
          }
        ],
        "primaryContact": {
          "email": "[email protected]",
          "firstName": "Jane",
          "id": "gid://ownright/Object/1",
          "isPrimary": true,
          "lastName": "Doe",
          "phoneNumber": "+14165551234"
        },
        "propertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "latitude": 1,
          "longitude": 1,
          "mapImageUrl": "https://example.com",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "shortTitle": "123 Main St, Toronto",
          "street": "123 Main St",
          "title": "123 Main St, Toronto",
          "unitNumber": "Suite 100"
        },
        "purchaseAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        },
        "mortgageAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        }
      },
      "userErrors": []
    }
  }
}

mutation PropertyClosingReferralCreate($input: PropertyClosingReferralInput!) {
  propertyClosingReferralCreate(input: $input) {
    referral {
      createdAt
      id
      status
      type
      updatedAt
      contacts {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      customAttributes {
        id
        key
        type
        value
      }
      primaryContact {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      ... on PurchasePropertyClosingReferral {
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
        purchaseAmount {
          amount
          currencyCode
        }
      }
      ... on RefinanceReferral {
        mortgageAmount {
          amount
          currencyCode
        }
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
      ... on SalePropertyClosingReferral {
        propertyAddress {
          city
          country
          latitude
          longitude
          mapImageUrl
          postalCode
          province
          shortTitle
          street
          title
          unitNumber
        }
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

{
  "input": {
    "contacts": [
      {
        "email": "[email protected]",
        "firstName": "Jane",
        "lastName": "Doe",
        "phoneNumber": "+14165551234",
        "primary": true
      }
    ],
    "customAttributes": [
      {
        "key": "example-key",
        "type": "BOOLEAN",
        "value": "example-value"
      }
    ],
    "files": [
      {
        "fileRecordId": "gid://ownright/FileRecord/1",
        "tags": [
          "example-tags"
        ]
      }
    ],
    "intentLevel": "HIGH",
    "purchaseAmount": {
      "amount": "100.00",
      "currencyCode": "CAD"
    },
    "purchasePropertyAddress": {
      "city": "Toronto",
      "country": "CANADA",
      "postalCode": "M5V 1A1",
      "province": "ALBERTA",
      "street": "123 Main St",
      "unitNumber": "Suite 100"
    },
    "salePropertyAddress": {
      "city": "Toronto",
      "country": "CANADA",
      "postalCode": "M5V 1A1",
      "province": "ALBERTA",
      "street": "123 Main St",
      "unitNumber": "Suite 100"
    },
    "type": "PURCHASE_PROPERTY_CLOSING"
  }
}

{
  "data": {
    "propertyClosingReferralCreate": {
      "referral": {
        "createdAt": "2025-01-15T10:30:00Z",
        "id": "gid://ownright/Object/1",
        "status": "CONVERTED",
        "type": "PURCHASE_PROPERTY_CLOSING",
        "updatedAt": "2025-01-15T10:30:00Z",
        "contacts": [
          {
            "email": "[email protected]",
            "firstName": "Jane",
            "id": "gid://ownright/Object/1",
            "isPrimary": true,
            "lastName": "Doe",
            "phoneNumber": "+14165551234"
          }
        ],
        "customAttributes": [
          {
            "id": "gid://ownright/Object/1",
            "key": "example-key",
            "type": "BOOLEAN",
            "value": "example-value"
          }
        ],
        "primaryContact": {
          "email": "[email protected]",
          "firstName": "Jane",
          "id": "gid://ownright/Object/1",
          "isPrimary": true,
          "lastName": "Doe",
          "phoneNumber": "+14165551234"
        },
        "propertyAddress": {
          "city": "Toronto",
          "country": "CANADA",
          "latitude": 1,
          "longitude": 1,
          "mapImageUrl": "https://example.com",
          "postalCode": "M5V 1A1",
          "province": "ALBERTA",
          "shortTitle": "123 Main St, Toronto",
          "street": "123 Main St",
          "title": "123 Main St, Toronto",
          "unitNumber": "Suite 100"
        },
        "purchaseAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        },
        "mortgageAmount": {
          "amount": "100.00",
          "currencyCode": "CAD"
        }
      },
      "userErrors": []
    }
  }
}

Mutation field

propertyClosingReferralCreate

Arguments

input

PropertyClosingReferralInput!

required

Input required to create a property closing referral.

Show properties

contacts

[ReferralContactCreateInput!]

Contacts to be associated with the referral.

Show properties

String!

required

The email for the referral contact.

firstName

String!

required

The first name for the referral contact.

lastName

String

The last name for the referral contact.

phoneNumber

String

The phone number for the referral contact.

primary

Boolean!

required

Whether this contact is the primary contact for the referral.

customAttributes

[CustomAttributeCreateInput!]

Custom attributes to be associated with the referral.

Show properties

key

String!

required

The key of the custom attribute.

type

CustomAttributeType!

required

The type of the custom attribute.

value

String!

required

The value of the custom attribute.

files

[FileBulkCommitInput!]!

required

The files to be associated with the referral.

Show properties

fileRecordId

FileRecordGID!

required

The identifier of a staged file record to commit.

Return fields

referral

Referral

The created referral.

Show properties

contacts

[ReferralContact!]!

required

The contacts for the referral.

Show properties

String!

required

The email of the contact.

firstName

String!

required

The first name of the contact.

GID!

required

ID of the object.

isPrimary

Boolean!

required

Whether the contact is the primary contact.

lastName

String

The last name of the contact.

phoneNumber

String

The phone number of the contact.

createdAt

ISO8601DateTime!

required

The time the referral was created.

customAttributes

[CustomAttribute!]!

required

The custom attributes for the referral.

Show properties

GID!

required

ID of the object.

key

String!

required

The key of the custom attribute.

type

CustomAttributeType!

required

The type of the custom attribute.

value

String!

required

The value of the custom attribute.

GID!

required

ID of the object.

primaryContact

ReferralContact!

required

The primary contact for the referral.

Show properties

String!

required

The email of the contact.

firstName

String!

required

The first name of the contact.

GID!

required

ID of the object.

isPrimary

Boolean!

required

Whether the contact is the primary contact.

lastName

String

The last name of the contact.

phoneNumber

String

The phone number of the contact.

status

ReferralStatus!

required

The current status of the referral.

type

ReferralType!

required

The type of the referral.

updatedAt

ISO8601DateTime!

required

The time the referral was updated.

userErrors

[PropertyClosingReferralCreateUserError!]!

required

List of errors that occurred while executing the mutation.

Show properties

code

PropertyClosingReferralCreateUserErrorCode

Error code associated with the error.

field

[String!]

The path to the input field that caused the error.

message

String!

required

A description of the error.

Types

AddressInput (input) — Input to create or update an address.
Country (enum) — Possible countries.
CurrencyCode (enum) — Possible currency codes.
CustomAttribute (object) — A custom attribute.
CustomAttributeCreateInput (input) — Input to create a custom attribute.
CustomAttributeType (enum) — Possible custom attribute types.
Decimal (scalar) — A signed decimal number, which supports arbitrary precision and is serialized as a string.
FileBulkCommitInput (input) — Input for a file to committed as part of a bulk file commit.
FileRecordGID (scalar) — A global identifier for a FileRecord object in format of ‘gid://ownright/FileRecord/ID’.
GID (scalar) — A global identifier for an object in the format of ‘gid://ownright/ObjectType/ID’.
ISO8601DateTime (scalar) — An ISO 8601-encoded datetime
MoneyInput (input) — Input that represents money.
PropertyClosingReferralCreatePayload (object) — Return type for the propertyClosingReferralCreate mutation.
PropertyClosingReferralCreateUserError (object) — An error that could occur during the execution of the propertyClosingReferralCreate mutation.
PropertyClosingReferralCreateUserErrorCode (enum) — Possible error codes that can be returned by PropertyClosingReferralCreateUserError.
PropertyClosingReferralInput (input) — Input to create a property closing referral.
Province (enum) — Possible provinces.
Referral (interface) — Represents a referral.
ReferralContact (object) — A contact for a referral.
ReferralContactCreateInput (input) — The input to create a referral contact.
ReferralIntentLevel (enum) — Possible levels of intent for a referral.
ReferralStatus (enum) — Possible statuses for referrals.
ReferralType (enum) — Possible types of referrals.

Property Closing Referral Bulk Create Refinance Referral Bulk Create

Getting Started

Core Concepts

Guides

API Reference

Queries

Mutations

Members

Webhooks

Mutation field

Arguments

Return fields

Types

​Mutation field

​Arguments

​Return fields

​Types

Mutation field

Arguments

Return fields

Types