Create a new portfolio

Create a new portfolio

Request Body Fields

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>avm</td><td>object</td><td></td><td></td> </tr> <tr><td>avm.relative_to</td><td>string</td><td>Reference Point From Which Avm is Calculated. Supported Values: "PORTFOLIO_CREATION" or "LAST_MONTH"</td><td>PORTFOLIO_CREATION</td> </tr> <tr><td>avm.thresholds</td><td>array</td><td></td><td></td> </tr> <tr><td>avm.thresholds[]</td><td>object</td><td></td><td></td> </tr> <tr><td>avm.thresholds[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>avm.thresholds[].value</td><td>number</td><td>Literal Value of AVM</td><td>0.3</td> </tr> <tr><td>emails</td><td>array</td><td></td><td></td> </tr> <tr><td>emails[]</td><td>string</td><td>Emails Addresses to Which Notifications Should be Sent</td><td>customer@email.com</td> </tr> <tr><td>lien</td><td>array</td><td></td><td></td> </tr> <tr><td>lien[]</td><td>string</td><td>Set of all Lien Types on Which to Notify. Notification will be generated when property assumes one of the listed liens. Supported Values: "ARM", "ASSUMPTION", "BALLOON", "CLOSED_END", "COMMERCIAL", "CONSTRUCTION", "CONVENTIONAL", "FANNIE_MAE_FREDDIE_MAC", "FARMERS_HOME_ADMINISTRATION", "FHA", "LAND_CONTRACT", "MODIFICATION", "NEGATIVE_AMORTIZATION", "NON_PURCHASE_MONEY", "OPEN_END", "OTHER", "PURCHASE_MONEY", "REVERSE", "REVOLVING_CREDIT_LINE", "SBA", "SECOND_TO_COVER_DOWN_PAYMENT", "SELLER_TAKE_BACK", "STAND_ALONE_FIRST", "STAND_ALONE_REFI", "STAND_ALONE_SECOND", "STATE_VETERANS", "UNKNOWN", "USDA", "VA"</td><td>FHA</td> </tr> <tr><td>ltv_thresholds</td><td>array</td><td></td><td></td> </tr> <tr><td>ltv_thresholds[]</td><td>object</td><td></td><td></td> </tr> <tr><td>ltv_thresholds[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>ltv_thresholds[].threshold</td><td>number</td><td>Value of LTV to trigger notification</td><td>0.6</td> </tr> <tr><td>mls_status</td><td>array</td><td></td><td></td> </tr> <tr><td>mls_status[]</td><td>string</td><td>Set of MLS Status on Which to Notify. Notification will be generated when property assumes one of the listed values. Supported Values: "EXPIRED", "WITHDRAWN", "COMING_SOON", "CLOSED", "PENDING", "DELETED", "LEASED", "SOLD", "CANCELLED", "CONTINGENT", "ACTIVE"</td><td>ACTIVE</td> </tr> <tr><td>name</td><td>string</td><td>Name of the Portfolio</td><td>My First Portfolio</td> </tr> <tr><td>nod</td><td>boolean</td><td>Notice of Default</td><td></td> </tr> <tr><td>propensity_to_list</td><td>array</td><td></td><td></td> </tr> <tr><td>propensity_to_list[]</td><td>object</td><td></td><td></td> </tr> <tr><td>propensity_to_list[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>propensity_to_list[].threshold</td><td>number</td><td>Value of Propensity to List to trigger notification</td><td>95</td> </tr> <tr><td>propensity_to_refi</td><td>array</td><td></td><td></td> </tr> <tr><td>propensity_to_refi[]</td><td>object</td><td></td><td></td> </tr> <tr><td>propensity_to_refi[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>propensity_to_refi[].threshold</td><td>number</td><td>Value of Propensity to Refi to trigger notification</td><td>55</td> </tr> </table>

Response

<table><tr><th>Field</th><th>Type</th><th>Description</th><th>Example</th></tr> <tr><td>data</td><td>object</td><td></td><td></td> </tr> <tr><td>data.asset_count</td><td>integer</td><td>Count of Assets in the Portfolio</td><td>100</td> </tr> <tr><td>data.avm</td><td>object</td><td></td><td></td> </tr> <tr><td>data.avm.relative_to</td><td>string</td><td>Reference Point From Which Avm is Calculated. Supported Values: "PORTFOLIO_CREATION" or "LAST_MONTH"</td><td>PORTFOLIO_CREATION</td> </tr> <tr><td>data.avm.thresholds</td><td>array</td><td></td><td></td> </tr> <tr><td>data.avm.thresholds[]</td><td>object</td><td></td><td></td> </tr> <tr><td>data.avm.thresholds[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>data.avm.thresholds[].value</td><td>number</td><td>Literal Value of AVM</td><td>0.3</td> </tr> <tr><td>data.columns</td><td>array</td><td></td><td></td> </tr> <tr><td>data.columns[]</td><td>string</td><td>Names of Each Column of the Portfolio</td><td>Value</td> </tr> <tr><td>data.date_created</td><td>string</td><td>Date when portfolio was created</td><td>2023-01-01T00:00:00Z</td> </tr> <tr><td>data.emails</td><td>array</td><td></td><td></td> </tr> <tr><td>data.emails[]</td><td>string</td><td>Emails Addresses to Which Notifications Should be Sent</td><td>customer@email.com</td> </tr> <tr><td>data.lien</td><td>array</td><td></td><td></td> </tr> <tr><td>data.lien[]</td><td>string</td><td>Set of all Lien Types on Which to Notify. Notification will be generated when property assumes one of the listed liens. Supported Values: "ARM", "ASSUMPTION", "BALLOON", "CLOSED_END", "COMMERCIAL", "CONSTRUCTION", "CONVENTIONAL", "FANNIE_MAE_FREDDIE_MAC", "FARMERS_HOME_ADMINISTRATION", "FHA", "LAND_CONTRACT", "MODIFICATION", "NEGATIVE_AMORTIZATION", "NON_PURCHASE_MONEY", "OPEN_END", "OTHER", "PURCHASE_MONEY", "REVERSE", "REVOLVING_CREDIT_LINE", "SBA", "SECOND_TO_COVER_DOWN_PAYMENT", "SELLER_TAKE_BACK", "STAND_ALONE_FIRST", "STAND_ALONE_REFI", "STAND_ALONE_SECOND", "STATE_VETERANS", "UNKNOWN", "USDA", "VA"</td><td>FHA</td> </tr> <tr><td>data.ltv_thresholds</td><td>array</td><td></td><td></td> </tr> <tr><td>data.ltv_thresholds[]</td><td>object</td><td></td><td></td> </tr> <tr><td>data.ltv_thresholds[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>data.ltv_thresholds[].threshold</td><td>number</td><td>Value of LTV to trigger notification</td><td>0.6</td> </tr> <tr><td>data.mls_status</td><td>array</td><td></td><td></td> </tr> <tr><td>data.mls_status[]</td><td>string</td><td>Set of MLS Status on Which to Notify. Notification will be generated when property assumes one of the listed values. Supported Values: "EXPIRED", "WITHDRAWN", "COMING_SOON", "CLOSED", "PENDING", "DELETED", "LEASED", "SOLD", "CANCELLED", "CONTINGENT", "ACTIVE"</td><td>ACTIVE</td> </tr> <tr><td>data.name</td><td>string</td><td>Name of the Portfolio</td><td>My First Portfolio</td> </tr> <tr><td>data.nod</td><td>boolean</td><td>Notice of Default</td><td></td> </tr> <tr><td>data.portfolio_id</td><td>string</td><td>Portfolio ID</td><td>a1b2c3d</td> </tr> <tr><td>data.propensity_to_list</td><td>array</td><td></td><td></td> </tr> <tr><td>data.propensity_to_list[]</td><td>object</td><td></td><td></td> </tr> <tr><td>data.propensity_to_list[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>data.propensity_to_list[].threshold</td><td>number</td><td>Value of Propensity to List to trigger notification</td><td>95</td> </tr> <tr><td>data.propensity_to_refi</td><td>array</td><td></td><td></td> </tr> <tr><td>data.propensity_to_refi[]</td><td>object</td><td></td><td></td> </tr> <tr><td>data.propensity_to_refi[].operator</td><td>string</td><td>Operator Used to Compute Threshold. Supported values: "lt" (Less Than), or "gt" (Greater Than)</td><td>lt</td> </tr> <tr><td>data.propensity_to_refi[].threshold</td><td>number</td><td>Value of Propensity to Refi to trigger notification</td><td>95</td> </tr> <tr><td>data.upload_status</td><td>object</td><td></td><td></td> </tr> <tr><td>data.upload_status.status</td><td>string</td><td>The Status of The Portfolio Upload Job</td><td>NOT_STARTED</td> </tr> <tr><td>data.upload_status.file_name</td><td>string</td><td>Name of File Currently Uploading</td><td>GreatPortfolio.csv</td> </tr> <tr><td>data.upload_status.latest_error_count</td><td>integer</td><td>Count of Errors Encountered When Uploading This Portfolio</td><td>1</td> </tr> <tr><td>data.upload_status.success_count</td><td>integer</td><td>Count of Addresses Successfully Uploaded in This Portfolio</td><td>799</td> </tr> <tr><td>data.upload_status.processed_count</td><td>integer</td><td>Count of All Addresses Processed for This Portfolio</td><td>800</td> </tr> <tr><td>data.upload_status.total_addresses_in_file</td><td>integer</td><td>Count of All Addresses in Uploaded Portfolio File</td><td>800</td> </tr> </table>

{
  "avm": {
    "relative_to": "PORTFOLIO_CREATION",
    "thresholds": [
      {
        "operator": "lt",
        "value": 0.3
      }
    ]
  },
  "emails": [
    "customer@email.com"
  ],
  "lien": [
    "FHA"
  ],
  "ltv_thresholds": [
    {
      "operator": "lt",
      "threshold": 0.6
    }
  ],
  "mls_status": [
    "ACTIVE"
  ],
  "name": "My First Portfolio",
  "propensity_to_list": [
    {
      "operator": "lt",
      "threshold": 95
    }
  ],
  "propensity_to_refi": [
    {
      "operator": "lt",
      "threshold": 55
    }
  ]
}

{
  "data": {
    "asset_count": 100,
    "avm": {
      "relative_to": "PORTFOLIO_CREATION",
      "thresholds": [
        {
          "operator": "lt",
          "value": 0.3
        }
      ]
    },
    "columns": [
      "Value"
    ],
    "date_created": "2023-01-01T00:00:00Z",
    "emails": [
      "customer@email.com"
    ],
    "lien": [
      "FHA"
    ],
    "ltv_thresholds": [
      {
        "operator": "lt",
        "threshold": 0.6
      }
    ],
    "mls_status": [
      "ACTIVE"
    ],
    "name": "My First Portfolio",
    "portfolio_id": "a1b2c3d",
    "propensity_to_list": [
      {
        "operator": "lt",
        "threshold": 95
      }
    ],
    "propensity_to_refi": [
      {
        "operator": "lt",
        "threshold": 95
      }
    ],
    "upload_status": {
      "status": "NOT_STARTED",
      "file_name": "GreatPortfolio.csv",
      "latest_error_count": 1,
      "success_count": 799,
      "processed_count": 800,
      "total_addresses_in_file": 800
    }
  }
}