OFFLIMIT: Off limit
An off-limits reason code explaining why a client or company is restricted from certain business activities.
Default definition. This article describes the default
OFFLIMIT 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 OFFLIMIT.Entity properties
| Property | Value |
|---|---|
| Entity code | OFFLIMIT |
| Display name | Off limit |
| Plural | Off limits |
| Level | 250 |
Use cases
OFFLIMIT provides a controlled vocabulary of reasons why a client may be placed off-limits for certain activities, particularly recruitment sourcing. It is referenced from CLIENT and COM records via the offlimits objectLookup in the Off Limits section, alongside an expiry date and description. Typical reasons might include 'Active client - do not headhunt', 'Contractual restriction', 'Legal dispute', etc.
Fields
Off limit
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name |
code | text | Code |
Relationships
- No declared relationships in the default definition.
Creating a Off limit via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "OFFLIMIT",
"level": 250,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"code": "EX"
}Listing Off limits records
# All off limits in your tenant
GET /v1/entities/OFFLIMIT/SUB