Sales campaigns
A marketing or sales initiative used to attract prospects, attribute commercial activity, and measure results.
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Position | rank | Order rank | Yes | |
| Name | label | Text I18n | ||
| Period start | dateStart | Date | First day the campaign is valid (owning team civil day). | |
| Period end | dateEnd | Date | Last day the campaign remains active (inclusive, owning team civil day). | |
| Content | content | Markdown I18n | ||
| Status | status | Constant | Lifecycle or processing state from the allowed values for this record. | |
| Image | image | Image | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area I18n | ||
| Data | data | Data | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event salescampaigns.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new campaign. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this campaign. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this campaign. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this campaign again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this campaign from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this campaign to active lists and actions. | App · WebMCP · API · MCP · CLI |
| Delete | delete | Delete this campaign and the data that belongs with it. This cannot be undone. | App · WebMCP · API · MCP · CLI |