SALECAMPAIGN: Campaign
The SALECAMPAIGN entity: A marketing campaign or offer associated with a product.
Default definition. This article describes the default
SALECAMPAIGN 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 SALECAMPAIGN.Entity properties
| Property | Value |
|---|---|
| Entity code | SALECAMPAIGN |
| Display name | Campaign |
| Plural | Campaigns |
| Level | 100001 |
Use cases
Child entity of PROD via comboKey (SUB|PROD). Each record is a campaign or promotional offer displayed in the product presentation during sales meetings.
Fields
Campaign
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Campaign name |
description | text (multi-line) | Yes | Description |
weight | number | Weight (0-1) |
Relationships
- No declared relationships in the default definition.
Creating a Campaign via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "SALECAMPAIGN",
"level": 100001,
"comboKey": "SUB:|ENT:",
"name": "Example name",
"description": "Example Description",
"weight": 1
} Listing Campaigns records
GET /v1/entities/SALECAMPAIGN/SUB