{"info":{"_postman_id":"f986c206-71ca-4ad4-97df-f90496389dd9","name":"RevOptimal API v3","description":"

Your solution for B2B revenue growth. Leverage the RevOptimal API to create and manage Revenue Targeting Models, driving your company's success with dynamic prospect prioritization.

Introduction

The RevOptimal API is a RESTful service structured by object-oriented endpoints, utilizing standard HTTP response codes and verbs. Detailed filtering is supported via query string parameters. Cross-account, user-based authorization enables focused access control and permissioning.

Revenue Targeting Models are the cornerstone of the RevOptimal API service. Dynamically trained with your CRM closed opportunity data, our machine-learning powered Models calculate variance and match prospect companies predicted to maximize sales of your product or service. Motivation signals are attached to the Models, instructing RevOptimal to monitor prospect company activity based on keywords, job postings, event attendance, and more. When activity is detected, Revenue Targeting Models quantify the strength of motivation to engage with your company, weighted by firmographic alignment, and prioritized by our proprietary RevScore.

Returned company data includes logo files, HQ locations, industries, business types, employee counts, revenue, funding, technographics, LinkedIn information, detected motivation signals, contact emails, and RevScore - everything your company needs to prioritize prospect outreach pipelines, intelligently manage account-based marketing campaigns, design sales organizations, and optimize revenue operations.

Environments

Documentation: https://developers.revoptimal.com

Production URL: https://api-v3.revoptimal.com

Sandbox URL: https://sandbox-v3.revoptimal.com

Responses

All endpoints return JSON-encoded responses and standard HTTP status codes. Error messages are designed to be displayed to end users.

Error response examples:

Response (401):

{\n    \"message\": \"This email and password combination is not valid.\"\n}\n\n

Response (404):

{\n    \"message\": \"Revenue Targeting Model could not be found.\"\n}\n\n

Response (429):

{\n    \"message\": \"Your account has been locked for 1 hour.\"\n}\n\n

Response (500):

{\n    \"message\": \"Our server experienced an unexpected error. We have been alerted to this error, please try again later.\"\n}\n\n

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"18224668","collectionId":"f986c206-71ca-4ad4-97df-f90496389dd9","publishedId":"2s9Xy2NBXn","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2023-08-08T21:27:49.000Z"},"item":[{"name":"Authentication","item":[{"name":"Tokens","id":"fac8a9ab-41f0-428c-bb57-08486330a48a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\": \"{{email}}\",\r\n \"password\": \"{{password}}\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/tokens/","urlObject":{"path":["tokens",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f1d8f6fc-db81-4826-8b79-e42b2ca32914","name":"Tokens","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"email\": \"george.p.burdell@revoptimal.com\",\r\n \"password\": \"iHeartRevOptimal\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-v2.revoptimal.com/tokens/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"token\": \"9e04d2c7-3733-4a30-bbc9-637cc4ba323a\",\n \"expires\": \"2021-10-26 23:56:35.113643+00:00\",\n \"id\": 1,\n \"name\": \"George P. Burdell\",\n \"email\": \"george.p.burdell@revoptimal.com\",\n \"accounts\": [\n 1,\n 2,\n 3\n ]\n}"}],"_postman_id":"fac8a9ab-41f0-428c-bb57-08486330a48a"}],"id":"dcb1e020-ce98-4a9d-b2f8-67bd71229d62","description":"

Email and password combinations are required to generate tokens which are used for authorizing subsequent API calls. Tokens are accepted for 12 hours after generation; it is suggested to store the token in a cookie governed by timestamp logic, although it is acceptable to attempt API actions to determine token validity and re-authenticate as necessary. The token is passed as Authorization in the header for all subsequent calls.

Email addresses are unique and must be associated with an active user object. Tokens are UUID format.

Note: This endpoint is rate limited to 5 requests per hour, per email address.

\n","_postman_id":"dcb1e020-ce98-4a9d-b2f8-67bd71229d62"},{"name":"Lookups","item":[{"name":"Example Files","id":"56adbadc-b9d3-4703-b72a-b5237558fbd9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/example-files/","urlObject":{"path":["example-files",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"fc512aa2-6819-464e-810d-036134e489d8","name":"Example Files","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://sandbox-v2.revoptimal.com/example-files/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"example_files\": [\n {\n \"name\": \"Training Dataset Example - Closed Opportunities\",\n \"url\": \"https://files.revoptimal.com/closed_opportunities_training_dataset_example.csv\"\n },\n {\n \"name\": \"Training Dataset Example - Domains\",\n \"url\": \"https://files.revoptimal.com/domains_training_dataset_example.csv\"\n }\n ]\n}"}],"_postman_id":"56adbadc-b9d3-4703-b72a-b5237558fbd9"},{"name":"Definitions","id":"74852b47-1083-4137-a31f-a3cb60a07928","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/definitions/","description":"

Note: An optional query string parameter fields accepts a comma delimited value of the definition keys and dictates the structure of the response; ex: ?fields=countries,business_types,revenue_bands.

\n","urlObject":{"path":["definitions",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9efe581e-210a-4a8f-a675-cea109403d22","name":"Definitions","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://sandbox-v2.revoptimal.com/definitions/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"countries\": [\n \"United States\",\n \"Canada\",\n \"Mexico\"\n ],\n \"business_types\": [\n \"B2B\",\n \"B2C\",\n \"B2G\"\n ],\n \"employee_bands\": [\n \"1 to 10\",\n \"11 to 50\",\n \"51 to 200\",\n \"201 to 1000\",\n \"1001 to 5000\",\n \"5001 to 10000\",\n \"10000+\"\n ],\n \"revenue_bands\": [\n \"$0 to $1M\",\n \"$1M to $10M\",\n \"$10M to $50M\",\n \"$50M to $100M\",\n \"$100M to $250M\",\n \"$250M to $1B\",\n \"$1B+\"\n ],\n \"training_dataset_formats\": [\n \"Domains\",\n \"Closed Opportunities\"\n ],\n \"model_goals\": [\n \"Revenue Discovery\",\n \"Revenue Protection\",\n \"Revenue Expansion\"\n ],\n \"contact_seniorities\": [\n \"Owner\",\n \"Partner\",\n \"Executive\",\n \"Vice President\",\n \"Director\",\n \"Manager\"\n ],\n \"contact_functions\": [\n \"Accounting\",\n \"Administrative\",\n \"Arts and Design\",\n \"Business Development\",\n \"Community & Social Services\",\n \"Consulting\",\n \"Education\",\n \"Engineering\",\n \"Entrepreneurship\",\n \"Finance\",\n \"Healthcare Services\",\n \"Human Resources\",\n \"Information Technology\",\n \"Legal\",\n \"Marketing\",\n \"Media & Communications\",\n \"Military & Protective Services\",\n \"Operations\",\n \"Product Management\",\n \"Program & Product Management\",\n \"Purchasing\",\n \"Quality Assurance\",\n \"Real Estate\",\n \"Research\",\n \"Sales\",\n \"Support\"\n ],\n \"motivation_signal_types\": [\n \"Website Page\",\n \"Competitor Interest\",\n \"Pain Point Research\",\n \"Solution Research\",\n \"Functional Investment\",\n \"Event and Webinar Attendance\"\n ]\n}"}],"_postman_id":"74852b47-1083-4137-a31f-a3cb60a07928"},{"name":"Users","id":"734b5e86-c8f4-4076-9f86-58e02fef27a6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/users/","description":"

Note: An optional query string parameter ids accepts a comma delimited value of User IDs, ex: ?ids=1,2,3

\n","urlObject":{"path":["users",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"5afaa6a3-580a-452d-bbac-7dd89720ed03","name":"Users","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://sandbox-v2.revoptimal.com/users/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"users\": [\n {\n \"id\": 1,\n \"name\": \"George P. Burdell\",\n \"email\": \"george.p.burdell@revoptimal.com\",\n \"accounts\": [\n 1,\n 2,\n 3\n ]\n }\n ]\n}"}],"_postman_id":"734b5e86-c8f4-4076-9f86-58e02fef27a6"},{"name":"Accounts","id":"0cb869cf-88b1-49ea-a043-0a057dfdee9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/accounts/","description":"

Note: An optional query string parameter ids accepts a comma delimited value of Account IDs, ex: ?ids=1,2,3

\n","urlObject":{"path":["accounts",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"761c2f66-0599-45f9-9127-b74ac273426f","name":"Accounts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://sandbox-v2.revoptimal.com/accounts/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"accounts\": [\n {\n \"id\": 1,\n \"name\": \"RevOptimal\",\n \"domain\": \"revoptimal.com\",\n \"tier\": {\n \"name\": \"Elite\",\n \"period\": \"Yearly\",\n \"model_cost\": \"$2,785\"\n },\n \"users\": [1, 2, 3]\n }\n ]\n}"}],"_postman_id":"0cb869cf-88b1-49ea-a043-0a057dfdee9f"}],"id":"9c513351-fd1f-40b7-8f7e-c30052d6e717","description":"

Note: All Lookup endpoints support only the GET method.

\n","_postman_id":"9c513351-fd1f-40b7-8f7e-c30052d6e717"},{"name":"Training Datasets","item":[{"name":"Training Datasets","id":"b83ae211-7dd9-43e2-be17-d539ba4cfd91","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/training-datasets/","urlObject":{"path":["training-datasets",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"faaaf16a-fe38-4000-9696-92877afe8c9e","name":"Training Datasets","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://sandbox-v2.revoptimal.com/training-datasets/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"training_datasets\": [\n {\n \"id\": 1,\n \"account\": 1,\n \"format\": \"Closed Opportunities\",\n \"original_file_name\": \"crm_export_10-26-2021.csv\",\n \"url\": \"https://files.revoptimal.com/65553f4c-74f4-47a7-867e-22055cd8a517.csv\",\n \"create_datetime\": \"2021-10-26 23:56:35.113643+00:00\"\n }\n ]\n}"}],"_postman_id":"b83ae211-7dd9-43e2-be17-d539ba4cfd91"},{"name":"Training Datasets","id":"a6043664-8044-4f38-822f-16724865a4f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"csv","type":"file","src":"/C:/Users/eslone/Desktop/training_dataset_example.csv"},{"key":"account","value":"1","type":"text"},{"key":"format","value":"Closed Opportunities","type":"text"}]},"url":"{{url}}/training-datasets/","urlObject":{"path":["training-datasets",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"76bc59af-f6dd-4f14-837b-0350ac45aa77","name":"Training Datasets","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"csv","type":"file","src":"/C:/Users/eslone/Desktop/training_dataset_example.csv"},{"key":"account","value":"1","type":"text"},{"key":"format","value":"Closed Opportunities","type":"text"}]},"url":"https://sandbox-v2.revoptimal.com/training-datasets/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"training_datasets\": [\n {\n \"id\": 1,\n \"account\": 1,\n \"format\": \"Closed Opportunities\",\n \"original_file_name\": \"training_dataset_example.csv\",\n \"url\": \"https://files.revoptimal.com/99953f4c-74f4-47a7-867e-22055cd8a517.csv\",\n \"create_datetime\": \"2021-10-26 23:56:35.113643+00:00\"\n }\n ]\n}"}],"_postman_id":"a6043664-8044-4f38-822f-16724865a4f9"}],"id":"fe6ae30f-6d5c-40a5-819b-4792919a3569","description":"

Note: Training dataset CSVs are uploaded to RevOptimal then attached to Revenue Targeting Model objects.

Note: The GET and POST methods are supported.

Note: An optional query string parameter ids accepts a comma delimited value of Training Dataset object IDs for all methods, ex: ?ids=1,2,3

Note: The POST method requires multipart/form-data for which the CSV file parameter name is agnostic, account is required with a valid ID value, and format is a required value from the Definitions endpoint; the response is application/json.

Note: Unique file names are not enforced.

\n","_postman_id":"fe6ae30f-6d5c-40a5-819b-4792919a3569"},{"name":"Revenue Targeting Models","item":[{"name":"Revenue Targeting Models","id":"13117e05-f532-4004-8f04-65c7035a5077","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/revenue-targeting-models/","urlObject":{"path":["revenue-targeting-models",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f2dbacbd-ae6d-453c-b62a-2ea0d90e20ba","name":"Revenue Targeting Models","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"https://sandbox-v2.revoptimal.com/revenue-targeting-models/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"revenue_targeting_models\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"2023 North American Sales\",\r\n \"create_datetime\": \"2023-01-26 23:56:35.113643+00:00\",\r\n \"account\": 1,\r\n \"active\": true,\r\n \"goal\": \"Revenue Discovery\",\r\n \"training_datasets\": [1, 2, 3],\r\n \"company_filters\": {\r\n \"countries\": [\"United States\", \"Canada\"],\r\n \"business_types\": [\r\n \"B2B\",\r\n \"B2C\",\r\n \"B2G\"\r\n ]\r\n },\r\n \"contact_filters\": {\r\n \"seniorities\": [\r\n \"Executive\",\r\n \"Vice President\"\r\n ],\r\n \"functions\": [\r\n \"Marketing\",\r\n \"Product Management\"\r\n ]\r\n },\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\",\r\n \"global_strength\": null\r\n },\r\n {\r\n \"value\": \"LeadCon\",\r\n \"type\": \"Event and Webinar Attendance\",\r\n \"global_strength\": 3\r\n },\r\n {\r\n \"value\": \"Revenue Operations\",\r\n \"type\": \"Functional Investment\",\r\n \"global_strength\": 7\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"13117e05-f532-4004-8f04-65c7035a5077"},{"name":"Revenue Targeting Models","id":"16b0af28-4fde-4b44-8558-4c38965d6616","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"2023 North American Sales\",\r\n \"create_datetime\": \"2023-01-26 23:56:35.113643+00:00\",\r\n \"account\": 1,\r\n \"active\": true,\r\n \"goal\": \"Revenue Discovery\",\r\n \"training_datasets\": [1, 2, 3],\r\n \"company_filters\": {\r\n \"countries\": [\"United States\", \"Canada\"],\r\n \"business_types\": [\r\n \"B2B\",\r\n \"B2C\",\r\n \"B2G\"\r\n ]\r\n },\r\n \"contact_filters\": {\r\n \"seniorities\": [\r\n \"Executive\",\r\n \"Vice President\"\r\n ],\r\n \"functions\": [\r\n \"Marketing\",\r\n \"Product Management\"\r\n ]\r\n },\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\"\r\n },\r\n {\r\n \"value\": \"LeadCon\",\r\n \"type\": \"Event and Webinar Attendance\"\r\n },\r\n {\r\n \"value\": \"Revenue Operations\",\r\n \"type\": \"Functional Investment\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/revenue-targeting-models/","urlObject":{"path":["revenue-targeting-models",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"89ff8ca3-972d-4f83-9aa1-fd10eaf869a6","name":"Revenue Targeting Models","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"2023 North American Sales\",\r\n \"create_datetime\": \"2023-01-26 23:56:35.113643+00:00\",\r\n \"account\": 1,\r\n \"active\": true,\r\n \"goal\": \"Revenue Discovery\",\r\n \"training_datasets\": [1, 2, 3],\r\n \"company_filters\": {\r\n \"countries\": [\"United States\", \"Canada\"],\r\n \"business_types\": [\r\n \"B2B\",\r\n \"B2C\",\r\n \"B2G\"\r\n ]\r\n },\r\n \"contact_filters\": {\r\n \"seniorities\": [\r\n \"Executive\",\r\n \"Vice President\"\r\n ],\r\n \"functions\": [\r\n \"Marketing\",\r\n \"Product Management\"\r\n ]\r\n },\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\"\r\n },\r\n {\r\n \"value\": \"LeadCon\",\r\n \"type\": \"Event and Webinar Attendance\"\r\n },\r\n {\r\n \"value\": \"Revenue Operations\",\r\n \"type\": \"Functional Investment\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-v2.revoptimal.com/revenue-targeting-models/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"2023 North American Sales\",\r\n \"create_datetime\": \"2023-01-26 23:56:35.113643+00:00\",\r\n \"account\": 1,\r\n \"active\": true,\r\n \"goal\": \"Revenue Discovery\",\r\n \"training_datasets\": [1, 2, 3],\r\n \"company_filters\": {\r\n \"countries\": [\"United States\", \"Canada\"],\r\n \"business_types\": [\r\n \"B2B\",\r\n \"B2C\",\r\n \"B2G\"\r\n ]\r\n },\r\n \"contact_filters\": {\r\n \"seniorities\": [\r\n \"Executive\",\r\n \"Vice President\"\r\n ],\r\n \"functions\": [\r\n \"Marketing\",\r\n \"Product Management\"\r\n ]\r\n },\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\",\r\n \"global_strength\": null\r\n },\r\n {\r\n \"value\": \"LeadCon\",\r\n \"type\": \"Event and Webinar Attendance\",\r\n \"global_strength\": 3\r\n },\r\n {\r\n \"value\": \"Revenue Operations\",\r\n \"type\": \"Functional Investment\",\r\n \"global_strength\": 7\r\n }\r\n ]\r\n}"}],"_postman_id":"16b0af28-4fde-4b44-8558-4c38965d6616"},{"name":"Revenue Targeting Models","id":"d9fee1c3-e4cb-4547-b38b-f3e57bc8f221","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"name\": \"2023 North American Sales\",\r\n \"create_datetime\": \"2023-01-26 23:56:35.113643+00:00\",\r\n \"account\": 1,\r\n \"active\": true,\r\n \"goal\": \"Revenue Discovery\",\r\n \"training_datasets\": [1, 2, 3],\r\n \"company_filters\": {\r\n \"countries\": [\"United States\", \"Canada\"],\r\n \"business_types\": [\r\n \"B2B\",\r\n \"B2C\",\r\n \"B2G\"\r\n ]\r\n },\r\n \"contact_filters\": {\r\n \"seniorities\": [\r\n \"Executive\",\r\n \"Vice President\"\r\n ],\r\n \"functions\": [\r\n \"Marketing\",\r\n \"Product Management\"\r\n ]\r\n },\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\"\r\n },\r\n {\r\n \"value\": \"LeadCon\",\r\n \"type\": \"Event and Webinar Attendance\"\r\n },\r\n {\r\n \"value\": \"Revenue Operations\",\r\n \"type\": \"Functional Investment\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/revenue-targeting-models/","urlObject":{"path":["revenue-targeting-models",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"fde64a16-71eb-48b2-8291-b597c0029348","name":"Revenue Targeting Models","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id\": 1,\r\n \"name\": \"2023 North American Sales\",\r\n \"create_datetime\": \"2023-01-26 23:56:35.113643+00:00\",\r\n \"account\": 1,\r\n \"active\": true,\r\n \"goal\": \"Revenue Discovery\",\r\n \"training_datasets\": [1, 2, 3],\r\n \"company_filters\": {\r\n \"countries\": [\"United States\", \"Canada\"],\r\n \"business_types\": [\r\n \"B2B\",\r\n \"B2C\",\r\n \"B2G\"\r\n ]\r\n },\r\n \"contact_filters\": {\r\n \"seniorities\": [\r\n \"Executive\",\r\n \"Vice President\"\r\n ],\r\n \"functions\": [\r\n \"Marketing\",\r\n \"Product Management\"\r\n ]\r\n },\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\"\r\n },\r\n {\r\n \"value\": \"LeadCon\",\r\n \"type\": \"Event and Webinar Attendance\"\r\n },\r\n {\r\n \"value\": \"Revenue Operations\",\r\n \"type\": \"Functional Investment\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://sandbox-v2.revoptimal.com/revenue-targeting-models/"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"id\": 1,\r\n \"name\": \"2023 North American Sales\",\r\n \"create_datetime\": \"2023-01-26 23:56:35.113643+00:00\",\r\n \"account\": 1,\r\n \"active\": true,\r\n \"goal\": \"Revenue Discovery\",\r\n \"training_datasets\": [1, 2, 3],\r\n \"company_filters\": {\r\n \"countries\": [\"United States\", \"Canada\"],\r\n \"business_types\": [\r\n \"B2B\",\r\n \"B2C\",\r\n \"B2G\"\r\n ]\r\n },\r\n \"contact_filters\": {\r\n \"seniorities\": [\r\n \"Executive\",\r\n \"Vice President\"\r\n ],\r\n \"functions\": [\r\n \"Marketing\",\r\n \"Product Management\"\r\n ]\r\n },\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\",\r\n \"global_strength\": null\r\n },\r\n {\r\n \"value\": \"LeadCon\",\r\n \"type\": \"Event and Webinar Attendance\",\r\n \"global_strength\": 3\r\n },\r\n {\r\n \"value\": \"Revenue Operations\",\r\n \"type\": \"Functional Investment\",\r\n \"global_strength\": 7\r\n }\r\n ]\r\n}"}],"_postman_id":"d9fee1c3-e4cb-4547-b38b-f3e57bc8f221"}],"id":"6d958118-6d8d-474e-a582-1d1596644d57","description":"

Note: The GET, POST, and PATCH methods are suported.

Note: An optional query string parameter ids accepts a comma separated value of Revenue Targeting Model IDs for the GET method, ex: ?ids=1,2,3

Note: An optional query string parameter account_ids accepts a comma separated value of Account IDs for the GET method, ex: ?account_ids=1,2,3

Note: An optional query string parameter active accepts true and false values for the GET method, ex: ?active=true

Note: An optional query string parameter fields accepts a comma separated value of Revenue Targeting Model properties for the GET method, dictating the structure of the response, ex: ?fields=name,active,training_datasets,filters

\n","_postman_id":"6d958118-6d8d-474e-a582-1d1596644d57"},{"name":"Companies","item":[{"name":"Companies","id":"be100807-aff3-4f64-b575-72ffccf53644","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/companies/?revenue_targeting_model_id=1","urlObject":{"path":["companies",""],"host":["{{url}}"],"query":[{"key":"revenue_targeting_model_id","value":"1"}],"variable":[]}},"response":[{"id":"83c57388-039f-4504-89a7-3ee217ac5ed6","name":"Companies","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-v2.revoptimal.com/companies/?revenue_targeting_model_id=1","protocol":"https","host":["sandbox-v2","revoptimal","com"],"path":["companies",""],"query":[{"key":"revenue_targeting_model_id","value":"1"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"page\": 1,\r\n \"page_size\": 50,\r\n \"total_objects\": 2350,\r\n \"companies\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"RevOptimal\",\r\n \"domain\": \"revoptimal.com\",\r\n \"logo_url\": \"https://images.revoptimal.com/revoptimal.com.png\",\r\n \"logo_width\": 128,\r\n \"logo_height\": 128,\r\n \"address\": \"600 W Peachtree St\",\r\n \"city\": \"Atlanta\",\r\n \"state\": \"Georgia\",\r\n \"state_code\": \"GA\",\r\n \"country\": \"United States\",\r\n \"country_code\": \"US\",\r\n \"zip_code\": \"30308\",\r\n \"sector\": \"Information Technology\",\r\n \"industry_group\": \"Software and Services\",\r\n \"industry\": \"Internet Software and Services\",\r\n \"subindustry\": \"Internet Software and Services\",\r\n \"linkedin_industry\": \"Computer Software\",\r\n \"linkedin_url\": \"https://linkedin.com/company/revoptimal/\",\r\n \"funding_raised\": 6000000,\r\n \"employee_band\": \"11 to 50\",\r\n \"revenue_band\": \"$1M to $10M\",\r\n \"business_type\": \"B2B\",\r\n \"revenue_targeting_models\": [\r\n {\r\n \"id\": 1,\r\n \"matched_datetime\": \"2021-10-26 23:56:35.113643+00:00\",\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\"\r\n }\r\n ],\r\n \"rev_score\": 100,\r\n \"export_url\": \"https://files.revoptimal.com/65553f4c-74f4-47a7-867e-22055cd8a517.csv\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"matched_datetime\": \"2021-10-26 23:56:35.113643+00:00\",\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com/pricing\",\r\n \"type\": \"Website Page\"\r\n }\r\n ],\r\n \"rev_score\": 100,\r\n \"export_url\": \"https://files.revoptimal.com/65553f4c-74f4-47a7-867e-22055cd8a517.csv\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"be100807-aff3-4f64-b575-72ffccf53644"}],"id":"ae31c988-b0cc-48d9-80b5-8f4a85fb2568","description":"

Note: Only the GET method is supported.

Query String Parameter Filters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Example
page	Pagination: page number (default is 1)	?page=3
page_size	Objects per page (default is 50)	?page_size=100
fields	Select which fields are returned for each object	?fields=name,domain
id	Filter by ids	?id=2,8,15,23
domain	Filter by domains	?domain=revoptimal.com
city	Filter by city	?city=boston,providence
state	Filter by state	?state=oregon,louisiana
industry	Filter objects whose industry that includes the search term(s)	?industry=software,tech
employee_band	Filter by employee bands	?employee_band='1 to 10','11 to 50'
revenue_band	Filter by revenue bands	?revenue_band='$1M to $10M'
revenue_targeting_model	Filter by revenue targeting model id	?revenue_targeting_model=1

page, page_size , and field are not required

One of the filtering parameters must be present in a request.

\n","_postman_id":"ae31c988-b0cc-48d9-80b5-8f4a85fb2568"},{"name":"Contacts","item":[{"name":"Contacts","id":"2edd32fa-335c-4f1e-bbc8-5944e9b883aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"{{url}}/contacts/?revenue_targeting_model_id=1","urlObject":{"path":["contacts",""],"host":["{{url}}"],"query":[{"key":"revenue_targeting_model_id","value":"1"},{"disabled":true,"key":"name","value":"George P Burdell"}],"variable":[]}},"response":[{"id":"f3c077fb-7180-4ad5-8cae-bfd951659d1f","name":"Contacts","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://sandbox-v2.revoptimal.com/contacts/?revenue_targeting_model_id=1","protocol":"https","host":["sandbox-v2","revoptimal","com"],"path":["contacts",""],"query":[{"key":"revenue_targeting_model_id","value":"1"}]}},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"page\": 1,\r\n \"page_size\": 50,\r\n \"total_objects\": 4425,\r\n \"contacts\": [\r\n {\r\n \"id\": 1,\r\n \"name\": \"George P Burdell\",\r\n \"title\": \"Chief Buzz Officer\",\r\n \"domain\": \"revoptimal.com\",\r\n \"linkedin_url\": \"https://www.linkedin.com/in/ramblingreckhelluvaengineer/\",\r\n \"email_addresses\": [\r\n {\r\n \"address\": \"george.p.burdell@revoptimal.com\",\r\n \"type\": \"Business\",\r\n \"last_known_delivery\": \"2021-10-26 23:56:35.113643+00:00\"\r\n }\r\n ],\r\n \"phone_numbers\": [\r\n {\r\n \"number\": \"+14045551234\",\r\n \"type\": \"Personal\"\r\n }\r\n ],\r\n \"address\": \"600 W Peachtree St\",\r\n \"city\": \"Atlanta\",\r\n \"state\": \"Georgia\",\r\n \"state_code\": \"GA\",\r\n \"country\": \"United States\",\r\n \"country_code\": \"US\",\r\n \"zip_code\": \"30308\",\r\n \"functions\": [\r\n \"Product Management\",\r\n \"Sales\",\r\n \"Marketing\"\r\n ],\r\n \"gender\": \"Male\",\r\n \"age_range\": \"65+\",\r\n \"net_worth\": \"$500,000 to $749,999\",\r\n \"homeowner\": true,\r\n \"work_history\": null,\r\n \"education_history\": null,\r\n \"revenue_targeting_models\": [\r\n {\r\n \"id\": 1,\r\n \"matched_datetime\": \"2021-10-26 23:56:35.113643+00:00\",\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com\",\r\n \"type\": \"Website Page\"\r\n }\r\n ],\r\n \"rev_score\": 100,\r\n \"export_url\": \"https://files.revoptimal.com/65553f4c-74f4-47a7-867e-22055cd8a517.csv\"\r\n },\r\n {\r\n \"id\": 2,\r\n \"matched_datetime\": \"2021-10-26 23:56:35.113643+00:00\",\r\n \"motivation_signals\": [\r\n {\r\n \"value\": \"revoptimal.com/pricing\",\r\n \"type\": \"Website Page\"\r\n }\r\n ],\r\n \"rev_score\": 100,\r\n \"export_url\": \"https://files.revoptimal.com/65553f4c-74f4-47a7-867e-22055cd8a517.csv\"\r\n }\r\n ]\r\n }\r\n ]\r\n}"}],"_postman_id":"2edd32fa-335c-4f1e-bbc8-5944e9b883aa"}],"id":"8eb61a94-37de-41a3-ac48-5a4f565c88e1","description":"

Note: Only the GET method is supported.

Querystring Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description	Example
page	Pagination: page number (default is 1)	?page=3
page_size	Objects per page (default is 50)	?page_size=100
fields	Select which fields are returned for each object	?fields=name,title
id	Filter by ids	?id=2,8,15,23
name	Filter by name	?name='George P Burdell'
domain	Filter by company domain	?domain=revoptimal.com
city	Filter by city	?city=boston,providence
state	Filter by state	?state=oregon,louisiana
industry	Filter objects whose industry that includes the search term(s)	?industry=software,tech
function	Filter by job function	?function=sales,marketing
age_range	Filter by age range	?age_range='65+'
net_worth	Filter by net worth	?net_worth='$500,000 to $749,999'
revenue_targeting_model	Filter by revenue targeting model id	?revenue_targeting_model=1

page, page_size , and field are not required

One of the filtering parameters must be present in a request.

\n","_postman_id":"8eb61a94-37de-41a3-ac48-5a4f565c88e1"}]}