ROE: Rule of engagement
The ROE entity: A rule of engagement defining how the business should interact with a specific client or company.
ROE definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches ROE.Entity properties
| Property | Value |
|---|---|
| Entity code | ROE |
| Display name | Rule of engagement |
| Plural | Rules of engagement |
| Level | 250 |
Use cases
ROE stores rules of engagement that govern how the business interacts with specific clients or companies. These rules are assigned via the roe objectLookup on both CLIENT and COM records (with create: true, allowing inline creation). Typical rules might include 'Do not cold call', 'Key account - senior contact only', 'Preferred supplier terms apply', etc.
The description field provides detailed guidance on what the rule means in practice. ROE is a recruitment-industry concept where certain clients have negotiated specific terms about how their account should be handled, but it applies equally to any business where client interaction protocols need to be formalised and visible to all users viewing a client record.
Fields
Rule of engagement
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name |
description | text (multi-line) | Description |
Relationships
- No declared relationships in the default definition.
Creating a Rule of engagement via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "ROE",
"level": 250,
"comboKey": "SUB:|ENT:",
"name": "Example name",
"description": "Example Description"
} Listing Rules of engagement records
GET /v1/entities/ROE/SUB