{"info":{"_postman_id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","name":"Partner API","description":"

The Realeflow Partner API is used by large organization's that have partnered with Realeflow to provide their users the best real estate investors tools in the industry. All requests require a key that will be provided, along with other necessary items like PlanId's during the setup process.

Note: If you have a custom domain set up for your white label - you should use your custom domain as the base URL for all endpoints.
For example to create accounts - you'd use the following URL:
https://app.customdomain.com/api/account?key={{Key}}

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1208064","collectionId":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","publishedId":"S1LsXpiZ","public":true,"customColor":{"top-bar":"222838","right-sidebar":"303030","highlight":"D3E1EB"},"publishDate":"2019-05-02T16:27:12.000Z"},"item":[{"name":"List Accounts","id":"e19e3a2b-012f-49ed-8391-16f3fe5c4a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://awesome.realeflow.com/api/account?key={{Key}}","description":"

Lists all accounts that are registered

Lists all users for a given account

Optional. If not provided, you must provide ExternalAccountId.

\n","type":"text/plain"},"key":"AccountId","value":"{{AccountId}}"},{"description":{"content":"

Optional. If not provided, you must provide AccountId.

\n","type":"text/plain"},"key":"ExternalAccountId","value":"{{ExternalAccountId}}"}],"variable":[]}},"response":[{"id":"1f1a19a5-c41e-4fe8-8453-231abff17218","name":"Success","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://awesome.realeflow.com/api/account/users?key={{Key}}&AccountId={{AccountId}}&ExternalAccountId={{ExternalAccountId}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","users"],"query":[{"key":"key","value":"{{Key}}"},{"key":"AccountId","value":"{{AccountId}}","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","description":"Optional. If not provided, you must provide AccountId."}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": \"12345678-eeee-ffff\",\r\n \"Login\": \"hpotter@hogwarts.edu\",\r\n \"UserName\": \"Harry Potter\",\r\n \"LastLogin\": \"2021-01-23T12:12:12.12\"\r\n }\r\n]"}],"_postman_id":"aacd32ce-7fb6-4bbd-8da0-6408a72e28b3"},{"name":"Account Details","id":"9dea88a5-ae01-45fc-aae3-7fc6deae59ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://awesome.realeflow.com/api/account?key={{Key}}&id={{ExternalAccountId}}&AccountId={{RealeflowId}}","description":"

Lists details from a single account.

You can look up an account using ExternalAccountId by providing the id parameter or using the account's internal RF AccountId by providing the AccountId parameter.

Make sure to only include one of these parameters.

Optional. If not provided, you must provide AccountId

\n","type":"text/plain"},"key":"id","value":"{{ExternalAccountId}}"},{"description":{"content":"

Optional. If not provided, you must provide id

\n","type":"text/plain"},"key":"AccountId","value":"{{RealeflowId}}"}],"variable":[]}},"response":[{"id":"17e999cf-76ae-4bb7-9786-07ee840045b8","name":"Get Details by ExternalAccountId","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://awesome.realeflow.com/api/account?id=54321&key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account"],"query":[{"key":"id","value":"54321"},{"key":"key","value":"{{Key}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r \"AccountId\": 12345,\r \"CompanyName\": \"Realeflow Buys Homes, LLC\",\r \"CompanyAddress\": \"1234 Main St.\",\r \"CompanyCity\": \"Cleveland\",\r \"CompanyState\": \"OH\",\r \"CompanyZipCode\": \"44130\",\r \"Contact\": \"Jane Smith\",\r \"ContactEmail\": \"jane.smith@realeflow.com\",\r \"AccountStatus\": \"Active\",\r \"Created\": \"2018-07-15T15:09:09.697\",\r \"CreatedBy\": \"Purchase Page\",\r \"SitePlanId\": 529,\r \"SitePlanName\": \"Realeflow Team\",\r \"ExternalAccountId\": \"54321\",\r \"SetupComplete\": true,\r \"HasPremiumLeads\": false\r}"},{"id":"51952e15-2269-4352-b9aa-df375c11a3f9","name":"Get Details by AccountId","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://awesome.realeflow.com/api/account?AccountId=12345&key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account"],"query":[{"key":"AccountId","value":"12345"},{"key":"key","value":"{{Key}}"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r \"AccountId\": 12345,\r \"CompanyName\": \"Realeflow Buys Homes, LLC\",\r \"CompanyAddress\": \"1234 Main St.\",\r \"CompanyCity\": \"Cleveland\",\r \"CompanyState\": \"OH\",\r \"CompanyZipCode\": \"44130\",\r \"Contact\": \"Jane Smith\",\r \"ContactEmail\": \"jane.smith@realeflow.com\",\r \"AccountStatus\": \"Active\",\r \"Created\": \"2018-07-15T15:09:09.697\",\r \"CreatedBy\": \"Purchase Page\",\r \"SitePlanId\": 529,\r \"SitePlanName\": \"Realeflow Team\",\r \"ExternalAccountId\": \"54321\",\r \"SetupComplete\": true,\r \"HasPremiumLeads\": false\r}"}],"_postman_id":"9dea88a5-ae01-45fc-aae3-7fc6deae59ee"},{"name":"Account Status Update","id":"818c45c1-3316-4beb-b2d8-7706ca7c4c5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{AccountId}}","type":"text","description":"

Optional. If not provided, you must provide ExternalAccountId.

\n"},{"key":"AccountStatus","value":"Active","type":"text","description":"

Required. Options: Active, ThirdPartyDecline, Inactive

\n"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","type":"text","description":"

Optional. If not provided, you must provide AccountId.

\n"}]},"url":"https://awesome.realeflow.com/api/account?key={{Key}}","description":"

Update an existing user account. You can use either the Account Id from a successful Account Create response or an External Account Id if it was sent in the original Account Create POST.

Upon a payment failure, please send an update request to set the status on the account to ThirdPartyDecline. Once the billing issue is resolved, please set the account back to Active.

If on decline & nonpayment, you would like us to redirect to a page that prompts the user to re-enter billing information, we would need that link provided to us. Otherwise, they will see a generic failure page telling them their account is suspended for nonpayment.

In the event of continous billing failure, you may decide to set the account to Inactive. However, please note that on an \"Inactive\" status update there is a permanent, non-reversible closure of the account. All stored user data (websites, documents, etc.) are removed from our system.

Additionally, it is worth noting that account innactivation removes the unique login email from our system & clears the ExternalAccountId. This allows a user to sign up for a new, fresh account in the future if they decide to return.

Optional. If not provided, you must provide ExternalAccountId.

\n","type":"text"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","description":"

Optional. If not provided, you must provide AccountId.

\n","type":"text"},{"key":"UserLimit","value":"{{UserLimit}}","description":"

Required. Must be integer value greater than 0.

\n","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/update/userlimit?key={{Key}}","description":"

Allows partner organization to update an existing account's user limit. You can use either the AccountId from a successful Account Create response or the ExternalAccountId if it was sent in the original Account Create POST.

Increasing the user limit will allow more users to be added to an account.

Decreasing the limit does not delete any existing users. However the account will not allow any additional users until the user count is below the limit again.

Optional. If not provided, you must provide ExternalAccountId.

\n","type":"text"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","description":"

Optional. If not provided, you must provide AccountId.

\n","type":"text"},{"key":"SitePlanId","value":"{{SitePlanId}}","description":"

Required. Must be integer value greater than 0.

\n","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/update/plan?key={{Key}}","description":"

Updates an account's base plan. You can use either the AccountId from a successful Account Create response or the ExternalAccountId if it was sent in the original Account Create POST.

Changing the base plan will alter the set of features available to an account.

Please note that certain feature changes may prompt additional actions from the user. (e.g. if AI zip limit was decreased, users will need to re-pick all their territories).

This endpoint only works for pre-established upgrade/downgrade paths. Work with the Realeflow development team if you want to add mappings for your organization.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"value","value":"{{key}}"}]},"isInherited":true,"source":{"_postman_id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","name":"Partner API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","account","update","plan"],"host":["awesome","realeflow","com"],"query":[{"key":"key","value":"{{Key}}"}],"variable":[]}},"response":[{"id":"9712c56a-8910-41ec-8c07-cce8a8a60566","name":"Success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"1234","description":"Optional. If not provided, you must provide ExternalAccountId.","type":"text"},{"key":"ExternalAccountId","value":"9876","description":"Optional. If not provided, you must provide AccountId.","type":"text"},{"key":"SitePlanId","value":"444","description":"Required. Must be integer value greater than 0.","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/update/plan?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","update","plan"],"query":[{"key":"key","value":"{{Key}}"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"FormerPlanId\": 333,\n \"NewPlanId\": 444,\n \"Notes\": \"Account site plan changed from 333 to 444. \",\n \"Success\": true,\n \"AccountId\": 1234,\n \"Error\": null\n}"},{"id":"9e8803a4-8b12-4a2b-a672-2f5be7e4780a","name":"Failure","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"1234","description":"Optional. If not provided, you must provide ExternalAccountId.","type":"text"},{"key":"ExternalAccountId","value":"9876","description":"Optional. If not provided, you must provide AccountId.","type":"text"},{"key":"SitePlanId","value":"444","description":"Required. Must be integer value greater than 0.","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/update/plan?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","update","plan"],"query":[{"key":"key","value":"{{Key}}"}]}},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"Success\": false,\r\n \"AccountId\": null,\r\n \"Error\": \"Invalid SitePlanId specified\"\r\n}"}],"_postman_id":"72ec2581-b5b7-4a93-8f1b-3b32af639e08"},{"name":"Create Account","id":"065062a3-6be9-4ffb-8623-94be71d04fa3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"FirstName","value":"Harry","type":"text","description":"

Required

\n"},{"key":"LastName","value":"Potter","type":"text","description":"

Required

\n"},{"key":"Email","value":"hpotter@hogwarts.edu","type":"text","description":"

Required

\n"},{"key":"PlanId","value":"{{PlanId}}","type":"text","description":"

Required. Your Plan ID's will be provided to you during the partner setup process

\n"},{"key":"ExternalAccountId","value":"{{ExternalId}}","type":"text","description":"

Optional. This is typically your organization's CRM Id. This can be used to make updates.

\n"},{"key":"Address","value":"1234 Privet Drive","type":"text","description":"

Optional

\n"},{"key":"City","value":"Cleveland","type":"text","description":"

Optional

\n"},{"key":"State","value":"OH","type":"text","description":"

Optional. Must be formatted as two letter acronym e.g. AZ, OH, etc.

\n"},{"key":"ZipCode","value":"44130","type":"text","description":"

Optional

\n"},{"key":"Phone","value":"440555455","type":"text","description":"

Optional

\n"}]},"url":"https://awesome.realeflow.com/api/account?key={{Key}}","description":"

This will create a new account for an end user. Tool availability is driven by the PlanId provided.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"value","value":"{{key}}"}]},"isInherited":true,"source":{"_postman_id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","name":"Partner API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","account"],"host":["awesome","realeflow","com"],"query":[{"key":"key","value":"{{Key}}"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"01457530-e692-49a3-bc50-91a93ec23500","name":"Create Account - Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"FirstName","value":"Harry","type":"text"},{"key":"LastName","value":"Potter","type":"text"},{"key":"Email","value":"hpotter@hogwarts.edu","type":"text"},{"key":"PlanId","value":"{{PlanId}}","type":"text"},{"key":"ExternalAccountId","value":"{{ExternalId}}","type":"text"},{"key":"Address","value":"1234 Privet Drive","type":"text"},{"key":"City","value":"Cleveland","type":"text"},{"key":"State","value":"OH","type":"text"},{"key":"ZipCode","value":"441330","type":"text"},{"key":"Phone","value":"440555455","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account"],"query":[{"key":"key","value":"{{Key}}"},{"key":"","value":"","type":"text","disabled":true}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"Error\": \"Example Error Message\"\r\n}"},{"id":"78005fba-67e5-4859-a9e7-532f593c776e","name":"Create Account - Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"FirstName","value":"Harry","type":"text"},{"key":"LastName","value":"Potter","type":"text"},{"key":"Email","value":"hpotter@hogwarts.edu","type":"text"},{"key":"PlanId","value":"{{PlanId}}","type":"text"},{"key":"ExternalAccountId","value":"{{ExternalId}}","type":"text"},{"key":"Address","value":"1234 Privet Drive","type":"text"},{"key":"City","value":"Cleveland","type":"text"},{"key":"State","value":"OH","type":"text"},{"key":"ZipCode","value":"441330","type":"text"},{"key":"Phone","value":"440555455","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account"],"query":[{"key":"key","value":"{{Key}}"},{"key":"","value":"","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":""},{"key":"Access-Control-Allow-Headers","value":""},{"key":"Access-Control-Allow-Methods","value":""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":""},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 02 May 2019 14:26:18 GMT"},{"key":"ETag","value":"W/\"af-MmpVeTvfnSW88c4riXD0uw\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Length","value":"148"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Success\": true,\r\n \"AccountId\": 1234\r\n}"}],"_postman_id":"065062a3-6be9-4ffb-8623-94be71d04fa3"},{"name":"Update External Account ID","id":"fbbf818d-9fb5-47d3-9d88-f003d16ac07f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/update/external?key={{Key}}","description":"

Allows partner organization to update external account id using the Realeflow ID. Important: you must save the Realeflow ID that is returned upon account creation OR by using the internal admin panel to find the Realeflow ID.

Retrieves a one-time use login token for single-user accounts. With the token and user ID, users can be programmatically logged in via /Account/Account/LogOnWithToken?id={{UserId}}&token={{Token}}. Token has time-based expiration if left unused.

Work with the Realeflow development team if you want to enable token authentication for your organization.

Optional. If not provided, you must provide ExternalAccountId.

\n","type":"text/plain"},"key":"AccountId","value":"{{AccountId}}"},{"description":{"content":"

Optional. If not provided, you must provide AccountId.

\n","type":"text/plain"},"key":"ExternalAccountId","value":"{{ExternalAccountId}}"}],"variable":[]}},"response":[{"id":"970492bd-732f-41e6-ba9a-4de44be3f082","name":"Success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"url":{"raw":"https://awesome.realeflow.com/api/account/user/logintoken?key={{Key}}&AccountId={{AccountId}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","user","logintoken"],"query":[{"key":"key","value":"{{Key}}"},{"key":"AccountId","value":"{{AccountId}}"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Credentials","value":""},{"key":"Access-Control-Allow-Headers","value":""},{"key":"Access-Control-Allow-Methods","value":""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Expose-Headers","value":""},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Date","value":"Thu, 02 May 2019 14:26:18 GMT"},{"key":"ETag","value":"W/\"af-MmpVeTvfnSW88c4riXD0uw\""},{"key":"Server","value":"nginx"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Content-Length","value":"148"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\r\n \"UserId\": \"12345678-eeee-ffff\",\r\n \"Token\": \"1234asdf\"\r\n}"}],"_postman_id":"b9d8ed27-c5fa-42d8-97af-e8b4bb5d56ed"},{"name":"Add Partner AddOn","id":"e19baefc-c506-416e-beee-1512a831ec15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"

Optional. If not provided, you must provide ExternalAccountId.

\n"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","type":"text","description":"

Optional. If not provided, you must provide ExternalAccountId.

\n"},{"key":"AddOnName","value":"{{AddOnName}}","description":"

Required. The name of the AddOn you’d like to enable. You should be provided this value by Realeflow

\n","type":"text"},{"key":"BillingFrequency","value":"{{BillingFrequency}}","description":"

Optional. Indicates the frequency that an account will be billed for the AddOn.\nValid Values: \nMONTHLY, ANNUAL, THREE_MONTH, SIX_MONTH

Coordinate with Realeflow team if you intend to utilize this feature.

\n","type":"text"},{"key":"AIZips","value":"{{AIZips}}","description":"

Optional. The number of Ai zip credits to grant to account. This parameter should only be passed when adding the Leadpipes AI AddOn.

\n","type":"text"},{"key":"AIStates","value":"{{AIStates}}","description":"

Optional. The number of Ai state credits to grant to account. This parameter should only be passed when adding the Leadpipes AI AddOn.

\n","type":"text"},{"key":"AICounties","value":"{{AICounties}}","description":"

Optional. The number of Ai county credits to grant to account. This parameter should only be passed when adding the Leadpipes AI AddOn.

\n","type":"text"},{"key":"CommercialSingleState","value":"{{CommercialSingleState}}","description":"

Optional. True/False indicating whether or not the account's access to commercial leads should be limited to a single state. If False is passed or the parameter is excluded entirely - the account will be given nationwide access. This parameter should only be passed when adding the Commercial Leads AddOn.

\n","type":"text"},{"key":"AINationwide","value":"{{AINationwide}}","description":"

Optional. True/False indicating whether or not nationwide AI access should be added. This parameter should only be passed when adding the Leadpipes AI AddOn.

\n","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/addon?key={{Key}}","description":"

Allows partner organization to enable an AddOn product using the account's RealeflowId or ExternalAccountId.

Available AddOns:

Partner Website Start
\n
Partner Website Accelerate
\n
Liens
\n
Leadpipes Premium
\n
Leadpipes AI
\n
Commercial Leads
\n
Residential Investor Leads
\n
Residential Flipper Leads
\n
Residential Landlord Leads
\n
Residential Note Holder Leads
\n
Residential Private Lender Leads
\n
Commercial Investor Leads
\n
Commercial Flipper Leads
\n
Commercial Landlord Leads
\n
Commercial Note Holder Leads
\n
Commercial Private Lender Leads
\n
Target Match AI
\n
Unlimited SkipTracing
\n
AI Score Preview
\n

Note: Work with Realeflow team to ensure the AddOns you need are avaiable for your API key.

Note: Residential and Commercial Investor Leads include Flipper, Landlord, Note Holder, and Private Lender lead types.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"value","value":"{{key}}"}]},"isInherited":true,"source":{"_postman_id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","name":"Partner API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","account","addon"],"host":["awesome","realeflow","com"],"query":[{"key":"key","value":"{{Key}}"}],"variable":[]}},"response":[{"id":"8188e9a6-2afa-4176-8ce5-fc6389245504","name":"Add Partner AddOn - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"ExternalAccountId","value":"123","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"AddOnName","value":"DFY Websites T4","description":"Required. The name of the AddOn you’d like to enable. You should be provided this value by Realeflow","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/addon?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","addon"],"query":[{"key":"key","value":"{{Key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"},{"id":"6db0cc68-11e2-459e-bd47-c685240fc077","name":"Add Partner AddOn - Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"ExternalAccountId","value":"123","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"AddOnName","value":"DFY Websites T4","description":"Required. The name of the AddOn you’d like to enable. You should be provided this value by Realeflow","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/addon?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","addon"],"query":[{"key":"key","value":"{{Key}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": false,\n \"Error\": \"DFY Websites T5 is already enabled on this account\"\n}"}],"_postman_id":"e19baefc-c506-416e-beee-1512a831ec15"},{"name":"Remove Partner AddOn","id":"667ae4d3-69cf-41a7-9105-beccf37faba3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"

Optional. If not provided, you must provide ExternalAccountId.

\n"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","type":"text","description":"

Optional. If not provided, you must provide ExternalAccountId.

\n"},{"key":"AddOnName","value":"{{AddOnName}}","description":"

Required. The name of the AddOn you’d like to enable. You should be provided this value by Realeflow

\n","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/addon?key={{Key}}","description":"

Allows partner organization to disable an AddOn product using the account's RealeflowId or ExternalAccountId.

Available AddOns:

Partner Website Start
\n
Partner Website Accelerate
\n
Liens
\n
Leadpipes Premium
\n
Leadpipes AI
\n
Commercial Leads
\n
Residential Investor Leads
\n
Residential Flipper Leads
\n
Residential Landlord Leads
\n
Residential Note Holder Leads
\n
Residential Private Lender Leads
\n
Commercial Investor Leads
\n
Commercial Flipper Leads
\n
Commercial Landlord Leads
\n
Commercial Note Holder Leads
\n
Commercial Private Lender Leads
\n
Target Match AI
\n

Note

Work with Realeflow team to ensure the AddOns you need are avaiable for your API key

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"value","value":"{{key}}"}]},"isInherited":true,"source":{"_postman_id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","name":"Partner API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","account","addon"],"host":["awesome","realeflow","com"],"query":[{"key":"key","value":"{{Key}}"}],"variable":[]}},"response":[{"id":"e11fecc9-be46-4a22-8619-4ed68b6d2ee6","name":"Remove Partner AddOn - Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"ExternalAccountId","value":"123","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"AddOnName","value":"DFY Websites T4","description":"Required. The name of the AddOn you’d like to enable. You should be provided this value by Realeflow","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/addon?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","addon"],"query":[{"key":"key","value":"{{Key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"},{"id":"5d100f0e-65a7-4400-b877-86ebd8d6d0d3","name":"Remove Partner AddOn - Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"ExternalAccountId","value":"123","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"AddOnName","value":"DFY Websites T4","description":"Required. The name of the AddOn you’d like to enable. You should be provided this value by Realeflow","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/addon?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","addon"],"query":[{"key":"key","value":"{{Key}}"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": false,\n \"Error\": \"DFY Websites T5 is not enabled on this account\"\n}"}],"_postman_id":"667ae4d3-69cf-41a7-9105-beccf37faba3"},{"name":"Get Ai Territories","id":"8348adf9-b71e-402b-b4d5-fbd523e38f2f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[]},"url":"https://awesome.realeflow.com/api/account/addon/ai/territories?key={{Key}}&AccountId={{AccountId}}&ExternalAccountId={{ExternalAccountId}}","description":"

List all subscribed Ai territories for an account.

Optional. If not provided, you must provide ExternalAccountId.

\n","type":"text/plain"},"key":"AccountId","value":"{{AccountId}}"},{"description":{"content":"

Optional. If not provided, you must provide AccountId.

\n","type":"text/plain"},"key":"ExternalAccountId","value":"{{ExternalAccountId}}"}],"variable":[]}},"response":[{"id":"084bfc3a-48f3-4b45-b8fd-f481386dd0e6","name":"Get Ai Territories Success","originalRequest":{"method":"GET","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"ExternalAccountId","value":"123","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"AIZips","value":"5","description":"Required. The number of Ai zip credits to grant to an account.","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/addon/ai/territories?key={{Key}}&AccountId=123","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","addon","ai","territories"],"query":[{"key":"key","value":"{{Key}}"},{"key":"AccountId","value":"123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"TerritoryId\": 123,\n \"Type\": \"State\",\n \"Value\": \"OH\"\n }\n]"}],"_postman_id":"8348adf9-b71e-402b-b4d5-fbd523e38f2f"},{"name":"Update Ai Credits","id":"a8d0e45f-1c80-4de1-a726-8ad1573a2b24","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"

Optional. If not provided, you must provide ExternalAccountId.

\n"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","type":"text","description":"

Optional. If not provided, you must provide AccountId.

\n"},{"key":"Credits","value":"{{Credits}}","description":"

Required. The number of Ai credits to be granted to an account.

\n","type":"text"},{"key":"Type","value":"{{Type}}","description":"

Required. Type of Ai credits to be updated. (Zip, County, or State)

\n","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/addon/ai/credits?key={{Key}}","description":"

Allows partner organization to set the number of Ai credits that an account has access to. The account must already have access to Leadpipes AI in order to use this endpoint.

The following credit types are supported:

Zip
\n
State
\n
County
\n

Leadpipes AI can be added to an account via the Add Partner AddOn endpoint

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"value","value":"{{key}}"}]},"isInherited":true,"source":{"_postman_id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","id":"d3eefb2a-1742-4d3d-aedf-65090ecbc57e","name":"Partner API","type":"collection"}},"urlObject":{"protocol":"https","path":["api","account","addon","ai","credits"],"host":["awesome","realeflow","com"],"query":[{"key":"key","value":"{{Key}}"}],"variable":[]}},"response":[{"id":"f9e48a10-370a-4075-a0db-ccaac16bd0c0","name":"Update Ai Zip Credits Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"ExternalAccountId","value":"123","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"Credits","value":"5","description":"Required. The number of Ai credits to be granted to an account.","type":"text"},{"key":"Type","value":"Zip","description":"Required. Type of Ai credits to be updated. (Zip, County, or State)","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/addon/ai/credits?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","addon","ai","credits"],"query":[{"key":"key","value":"{{Key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true\n}"},{"id":"e8512689-8c9d-4a20-adb0-a95cdc533684","name":"Update Ai Zip Credits Failure","originalRequest":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"ExternalAccountId","value":"123","type":"text","description":"Optional. If not provided, you must provide ExternalAccountId."},{"key":"Credits","value":"500","description":"Required. The number of Ai credits to be granted to an account.","type":"text"},{"key":"Type","value":"Zip","description":"Required. Type of Ai credits to be updated. (Zip, County, or State)","type":"text"}]},"url":{"raw":"https://awesome.realeflow.com/api/account/addon/ai/credits?key={{Key}}","protocol":"https","host":["awesome","realeflow","com"],"path":["api","account","addon","ai","credits"],"query":[{"key":"key","value":"{{Key}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Success\": true,\n \"Error\": \"Number of credits should be between 1 and 100\"\n}"}],"_postman_id":"a8d0e45f-1c80-4de1-a726-8ad1573a2b24"},{"name":"Redeem Ai Credit","id":"55a84256-ce36-4745-9913-62eadab9ef00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"urlencoded","urlencoded":[{"key":"AccountId","value":"{{RealeflowId}}","type":"text","description":"

Optional. If not provided, you must provide ExternalAccountId.

\n"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","type":"text","description":"

Optional. If not provided, you must provide AccountId.

\n"},{"key":"Type","value":"{{Type}}","description":"

Required. Type of Ai territory to be added. (Zip, County, or State)

\n","type":"text"},{"key":"Territory","value":"{{Territory}}","description":"

Required. Territory that will be subscribed to. Can be a zip, state, or county.

\n","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/addon/ai/territories?key={{Key}}","description":"

Allows partner organization to subscribe an account to an Ai territory. The account must already have access to Leadpipes AI and have credits available in order to use this endpoint.

Leadpipes AI can be added to an account via the Add Partner AddOn endpoint.

Ai credits can be added via the Update Ai Credits endpoint.

Optional. If not provided, you must provide ExternalAccountId.

\n","type":"text"},{"key":"ExternalAccountId","value":"{{ExternalAccountId}}","description":"

Optional. If not provided, you must provide AccountId.

\n","type":"text"},{"key":"TerritoryId","value":"{{TerritoryId}}","description":"

Required. Id of the territory to be deleted.

\n","type":"text"}]},"url":"https://awesome.realeflow.com/api/account/addon/ai/territories?key={{Key}}","description":"

Allows partner organization to unsubscribe an account from an Ai territory.

TerritoryId can be located using the Get Ai Territories endpoint.