Skip to main content
mutation RefinanceReferralBulkCreate($input: [RefinanceReferralInput!]!) {
  refinanceReferralBulkCreate(input: $input) {
    referrals {
      createdAt
      id
      status
      type
      updatedAt
      contacts {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      customAttributes {
        id
        key
        type
        value
      }
      mortgageAmount {
        amount
        currencyCode
      }
      primaryContact {
        email
        firstName
        id
        isPrimary
        lastName
        phoneNumber
      }
      propertyAddress {
        city
        country
        latitude
        longitude
        mapImageUrl
        postalCode
        province
        shortTitle
        street
        title
        unitNumber
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

{
  "data": {
    "refinanceReferralBulkCreate": {
      "referrals": [
        {
          "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"
            }
          ],
          "mortgageAmount": {
            "amount": "100.00",
            "currencyCode": "CAD"
          },
          "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"
          }
        }
      ],
      "userErrors": []
    }
  }
}

​
Mutation field

refinanceReferralBulkCreate

​
Arguments

​
input
[RefinanceReferralInput!]!
required
Input required to create refinance referrals.

​
Return fields

​
referrals
[RefinanceReferral!]
The created referrals.
​
userErrors
[RefinanceReferralBulkCreateUserError!]!
required
List of errors that occurred while executing the mutation.

​
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 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 ReferralIntentLevel {
  HIGH # Represents a high intent level for a referral.
  LOW # Represents a low intent level for a referral.
  MEDIUM # Represents a medium intent level for a referral.
}

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.
}

enum RefinanceReferralBulkCreateUserErrorCode {
  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.
}

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
scalar Url # A valid URL, transported as a string.