Odoo 19.0 Community · Persistent

crm.reveal.rule: fields, relations and API

The crm.reveal.rule model ("CRM Lead Generation Rules") is a persistent model declared by the Lead Generation From Website Visits module. It exposes 32 fields, 26 of them declared directly on the model; 2 fields from other models point to it. Below you will find every field with its technical name, type, label and relations, followed by an Odoo 19 JSON-2 API call.

View source code Search another model

Model identity

Technical name: crm.reveal.rule
Label: CRM Lead Generation Rules
Type: Persistent (models.Model)
SQL table: crm_reveal_rule
Origin module: Lead Generation From Website Visits (website_crm_iap_reveal)
Default order (_order): sequence

Model fields

26 own fields, 0 inherited from mixins and 6 automatic ORM fields. Click a name to get a direct link to that field.

Hide inherited fields

32 of 32 fields shown

Technical name	Label	Type	Details
active	Active	`boolean`
company_size_max	Company Size Max	`integer`
company_size_min	Company Size	`integer`
contact_filter_type	Filter On	`selection`	required Values: `role` (Role), `seniority` (Seniority)
country_ids	Countries Only visitors of following countries will be converted into leads/opportunities (using GeoIP).	`many2many` → res.country
extra_contacts	Number of Contacts This is the number of contacts to track if their role/seniority match your criteria. Their details will show up in the history thread of generated leads/opportunities. One credit is consumed per tracked contact.	`integer`
filter_on_size	Filter on Size Filter companies based on their size.	`boolean`
industry_tag_ids	Industries Leave empty to always match. Odoo will not create lead if no match	`many2many` → crm.iap.lead.industry
lead_count	Number of Generated Leads	`integer`	computed
lead_for	Data Tracking Choose whether to track companies only or companies and their contacts	`selection`	required Values: `companies` (Companies), `people` (Companies and their Contacts)
lead_ids	Generated Lead / Opportunity	`one2many` → crm.lead	inverse: `reveal_rule_id`
lead_type	Type	`selection`	required Values: `lead` (Lead), `opportunity` (Opportunity)
name	Rule Name	`char`	required
opportunity_count	Number of Generated Opportunity	`integer`	computed
other_role_ids	Other Roles	`many2many` → crm.iap.lead.role
preferred_role_id	Preferred Role	`many2one` → crm.iap.lead.role
priority	Priority	`selection`	Values: `0` (Normal), `1` (Good), `2` (Very Good), `3` (Excellent)
regex_url	URL Expression Regex to track website pages. Leave empty to track the entire website, or / to target the homepage. Example: /page* to track all the pages which begin with /page	`char`
seniority_id	Seniority	`many2one` → crm.iap.lead.seniority
sequence	Sequence Used to order the rules with same URL and countries. Rules with a lower sequence number will be processed first.	`integer`
state_ids	States Only visitors of following states will be converted into leads/opportunities.	`many2many` → res.country.state
suffix	Suffix This will be appended in name of generated lead so you can identify lead/opportunity is generated with this rule	`char`
tag_ids	Tags	`many2many` → crm.tag
team_id	Sales Team	`many2one` → crm.team
user_id	Salesperson	`many2one` → res.users
website_id	Website Restrict Lead generation to this website.	`many2one` → website
create_date	Created on	`datetime`	read-onlyautomatic
create_uid	Created by	`many2one` → res.users	read-onlyautomatic
display_name	Display Name	`char`	read-onlycomputedautomatic
id	ID	`integer`	read-onlyautomatic
write_date	Last Updated on	`datetime`	read-onlyautomatic
write_uid	Last Updated by	`many2one` → res.users	read-onlyautomatic

Relations

Models linked from this model

crm.iap.lead.industry: industry_tag_ids
crm.iap.lead.role: other_role_ids, preferred_role_id
crm.iap.lead.seniority: seniority_id
crm.lead: lead_ids
crm.tag: tag_ids
crm.team: team_id
res.country: country_ids
res.country.state: state_ids
res.users: user_id
website: website_id

Fields of other models pointing here

crm.lead: reveal_rule_id
crm.reveal.view: reveal_rule_id

Reading this model through the API

Odoo 19 JSON-2 API call reading the first five records with real fields of the model. Replace the instance, database and API key with your own.

curl

curl -X POST "https://your-instance.odoo.com/json/2/crm.reveal.rule/search_read" \
  -H "Authorization: bearer $ODOO_API_KEY" \
  -H "X-Odoo-Database: your-db" \
  -H "Content-Type: application/json" \
  -d '{"domain":[],"fields":["name","contact_filter_type","lead_for","lead_type","preferred_role_id"],"limit":5}'

Python (requests)

import requests

BASE_URL = "https://your-instance.odoo.com/json/2"
headers = {"Authorization": f"bearer {API_KEY}", "X-Odoo-Database": "your-db"}

res = requests.post(
    f"{BASE_URL}/crm.reveal.rule/search_read",
    headers=headers,
    json={"domain": [], "fields": ["name","contact_filter_type","lead_for","lead_type","preferred_role_id"], "limit": 5},
)
res.raise_for_status()
print(res.json())

External API access requires Odoo's Custom plan.
XML-RPC and JSON-RPC will be removed in Odoo 22 (fall 2028): use JSON-2.
The access rights and record rules of the key's user apply.

Cite this tool

Writing a tutorial, internal documentation or a forum answer? Copy this link to send your readers to the up-to-date reference.

<a href="https://aidoo.ai/en/outils/explorateur-modeles-odoo/crm-reveal-rule">crm.reveal.rule (Odoo 19.0)</a>

Sources

Data verified on September 23, 2026 · Odoo 19.0 Community

Have an Odoo project, or want to put your ERP to work with AI? Let's talk

Implementation, custom module development, connecting Claude or ChatGPT to your data: tell us about your context and we will reply within 24 business hours.