{"info":{"_postman_id":"e499eb32-b7ad-48c3-bffd-7d5e1ebf1fd9","name":"RingLead API","description":"

Enrich

\n

Welcome to the Enrich API documentation for RingLead!

\nYou will need to have a few things setup first before you can start coding.\n\n\n

Your Input Fields can be found in your Package on each vendor tab as shown below. These fields will be used when you setup your requests.

\n\n\n

Input Parameters

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Parameter
Required
Description
API Field - InputYesThe API field used as an input parameter from your Package Manage screen. Please note that you can have multiple inputs depending upon your preference and vendor package availability.
\n

Output Parameters

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
Parameter
Description
PackageThe package you are using for this current task. This information number can be found in the URL of your Package Manage task.
UsageYour RingLead usage indicating the response and number of credits used. Please note that this does not include vendor usage. You will need to monitor that independently if it does not come as part of a vendors response.
TimeThe time it took for the record to be enriched.
\n

Example Usage Responses

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Enrich","slug":"enrich"}],"owner":"9347456","collectionId":"e499eb32-b7ad-48c3-bffd-7d5e1ebf1fd9","publishedId":"TVsrGV87","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"016EB9"},"publishDate":"2020-12-17T20:41:57.000Z"},"item":[{"name":"Enrich API","id":"219628e7-e5e3-4759-a4b0-80c8a804a587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Records\": [\r\n {\r\n \"Website\": \"ringlead.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://test.ringlead.com/api/v1/webapi/5a1e5734-29d4-4e6f-9720-6f2ec2c919ec/submission/","description":"

Note: Requests and responses will vary from which vendors you choose.

\n\n

Please obtain your POST URL from your RingLead Enrich API Task as shown below.\n

\n","urlObject":{"protocol":"https","path":["api","v1","webapi","5a1e5734-29d4-4e6f-9720-6f2ec2c919ec","submission",""],"host":["test","ringlead","com"],"query":[],"variable":[]}},"response":[{"id":"93f87d02-a0ee-41e3-8adf-0511f9216384","name":"Enrich API","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Records\": [\r\n {\r\n \"Website\": \"ringlead.com\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://dms.ringlead.com/api/v1/webapi/5a1e5734-29d4-4e6f-9720-6f2ec2c919ec/submission/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Thu, 17 Dec 2020 20:23:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Vary","value":"Origin, Cookie"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Access-Control-Allow-Methods","value":"POST, OPTIONS"},{"key":"Allow","value":"POST, OPTIONS"},{"key":"Expires","value":"Thu, 17 Dec 2020 20:23:12 GMT"},{"key":"Cache-Control","value":"max-age=0, no-cache, no-store, must-revalidate, private"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Security-Policy","value":"font-src 'self' data: *.bootstrapcdn.com; script-src 'self' 'unsafe-eval' 'unsafe-inline' *.bootstrapcdn.com code.jquery.com; default-src 'self'; style-src 'self' 'unsafe-inline' *.bootstrapcdn.com; frame-ancestors 'self' *.eloqua.com; img-src 'self' data:"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"AppName\": null,\n \"AppUserId\": null,\n \"Records\": [\n {\n \"BritishSIC\": \"62012\",\n \"BritishSICDescription\": \"Business and domestic software development\",\n \"CompanyBlogUrl\": \"http://www.ringlead.com/feed/\",\n \"CompanyFacebookHandle\": \"https://www.facebook.com/ringleadinc\",\n \"CompanyFacebookUrl\": \"https://facebook.com/https://www.facebook.com/ringleadinc\",\n \"CompanyLinkedinHandle\": \"https://www.linkedin.com/company/ringlead-inc-\",\n \"CompanyLinkedinUrl\": \"https://linkedin.com/https://www.linkedin.com/company/ringlead-inc-\",\n \"CompanyName\": \"RingLead, Inc.\",\n \"CompanyStatus\": \"Operating\",\n \"CompanyTwitterHandle\": \"https://twitter.com/ringlead\",\n \"CompanyTwitterUrl\": \"https://twitter.com/https://twitter.com/ringlead\",\n \"CompanyWebsites\": \"https://www.ringlead.com/\",\n \"Employees\": \"80\",\n \"EmployeesRange\": \"51-200\",\n \"EnrichedOn\": \"2020-12-17T20:23:11Z\",\n \"EnrichmentTaskName\": \"Enrich API - Full Walkthrough Training\",\n \"HQCity\": \"Melville\",\n \"HQCountry\": \"United States\",\n \"HQCountryCode\": \"US\",\n \"HQState\": \"New York\",\n \"HQStateCode\": \"NY\",\n \"HQStreet1\": \"200 Broadhollow Road, Suite 400\",\n \"Industry\": \"Computer Software\",\n \"IndustrySub\": \"Business Intelligence Software\",\n \"VendorARecordID\": \"1882646\",\n \"VendorACompanySources\": \"User Generated, Web References, LinkSV, VendorA, VendorB, Community\",\n \"VendorAConfidenceScore\": \"75.0\",\n \"VendorAIndustryCode\": \"8\",\n \"VendorASubIndustryCode\": \"8_10\",\n \"NAICS\": \"511210\",\n \"NAICSDescription\": \"Software Publishers\",\n \"Phone1\": \"+1 925 778 4505\",\n \"Revenue\": \"4000000\",\n \"RevenueCurrency\": \"USD\",\n \"SIC\": \"7371\",\n \"SICDescription\": \"Services-Computer Programming Services\",\n \"Website\": \"ringlead.com\",\n \"YearEstablished\": \"2003\",\n \n \"Log\": [\n {\n \"step\": \"Incoming Record\",\n \"input\": {\n \"Website\": \"ringlead.com\"\n }\n },\n {\n \"step\": \"VendorAEnrich\",\n \"input\": {\n \"Website\": \"ringlead.com\"\n },\n \"output\": {\n \"VendorACompanyRecordID\": \"1882646\",\n \"HQCity\": \"Melville\",\n \"CompanyStatus\": \"Operating\",\n \"HQCountry\": \"United States\",\n \"HQCountryCode\": \"US\",\n \"Employees\": \"80\",\n \"EmployeesRange\": \"51-200\",\n \"Industry\": \"Computer Software\",\n \"NAICS\": \"511210\",\n \"NAICSDescription\": \"Software Publishers\",\n \"CompanyName\": \"RingLead, Inc.\",\n \"Phone1\": \"+1 925 778 4505\",\n \"Revenue\": \"4000000\",\n \"SIC\": \"7371\",\n \"SICDescription\": \"Services-Computer Programming Services\",\n \"HQState\": \"New York\",\n \"HQStateCode\": \"NY\",\n \"HQStreet1\": \"200 Broadhollow Road, Suite 400\",\n \"IndustrySub\": \"Business Intelligence Software\",\n \"RevenueCurrency\": \"USD\",\n \"VendorAIndustryCode\": \"8\",\n \"VendorASubIndustryCode\": \"8_10\",\n \"BritishSIC\": \"62012\",\n \"BritishSICDescription\": \"Business and domestic software development\",\n \"YearEstablished\": \"2003\",\n \"CompanyFacebookHandle\": \"https://www.facebook.com/ringleadinc\",\n \"CompanyFacebookUrl\": \"https://facebook.com/https://www.facebook.com/ringleadinc\",\n \"CompanyTwitterHandle\": \"https://twitter.com/ringlead\",\n \"CompanyTwitterUrl\": \"https://twitter.com/https://twitter.com/ringlead\",\n \"CompanyLinkedinHandle\": \"https://www.linkedin.com/company/ringlead-inc-\",\n \"CompanyLinkedinUrl\": \"https://linkedin.com/https://www.linkedin.com/company/ringlead-inc-\",\n \"CompanyBlogUrl\": \"http://www.ringlead.com/feed/\",\n \"VendorACompanySources\": \"User Generated, Web References, LinkSV, VendorA, VendorB, Community\",\n \"Website\": \"ringlead.com\",\n \"CompanyWebsites\": \"https://www.ringlead.com/\",\n \"VendorAScore\": \"75.0\"\n },\n \"package\": 42,\n \"usage\": {\n \"CACHED_API_CALL\": 1,\n \"GOOD_MATCH_CACHED_API_CALL\": 1,\n \"API_CREDIT\": 1\n },\n \"time\": 0.012598991394042969\n }\n ]\n }\n ],\n \n \"ProcessingStatus\": {\n \"RequestIP\": \"33.33.33.33\",\n \"EnabledPackages\": [\n 42\n ],\n \"UsedCredits\": {\n \"API_CREDIT\": 1\n },\n \"RemainingCredits\": {\n \"API_CREDIT\": null\n }\n }\n}\n"}],"_postman_id":"219628e7-e5e3-4759-a4b0-80c8a804a587"}]}