EMAILLIMIT: Email limit
An email limit rule defining maximum email volumes per time period to prevent over-communication with clients.
EMAILLIMIT 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 EMAILLIMIT.Entity properties
| Property | Value |
|---|---|
| Entity code | EMAILLIMIT |
| Display name | Email limit |
| Plural | Email limits |
| Level | 250 |
Use cases
EMAILLIMIT defines throttling rules for outbound email communication, assigned to CLIENT and COM records via the emaillimit objectLookup in the Administration panel's Email Restrictions section. Each rule specifies a maximum quantity (qty) of emails within a number of days (days), with a type field distinguishing between counting by individual email (each email counts as one) and counting by unique email address (multiple emails to the same address count as one). This entity prevents sales and recruitment teams from over-contacting clients by enforcing limits at the client level. For example, a rule might specify 'Maximum 5 emails per 30 days, counted by address' to prevent email fatigue. The separation of limit definitions from client records allows the same rule to be shared across multiple clients with similar communication preferences.
Fields
Email limit
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
qty | number | Yes | Quantity. |
days | number | Yes | Number of days. |
type | singleselect | Yes | Type. |
Relationships
- No declared relationships in the default definition.
Creating a Email limit via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "EMAILLIMIT",
"level": 250,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"qty": 0,
"days": 0,
"type": "Example value"
}
Listing Email limits records
GET /v1/entities/EMAILLIMIT/SUB:<your-sub-id>