Crm.Marketing.Campaigns Entity

Namespace: Crm.Marketing

Marketing campaigns. Used to treat target groups with marketing messages, plan budgets and marketing activities. Entity: Crm_Campaigns

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Crm.Marketing.Campaigns

Attributes

Name	Type	Description
Description	string (254) nullable	Campaign description.
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
EndDate	datetime nullable	End date of the campaign. null means that the end date is still unknown. `Filter(ge;le)`
ForecastedCost	decimal (18, 0)	Forecasted total cost of the campaign. `Required` `Default(0)`
Id	guid
IsActive	boolean	Indicates whether the current Campaign is active. `Required` `Default(true)` `Filter(eq)` `Introduced in version 24.1.5.19`
Name	string (64)	Short name of the campaign. `Required` `Filter(like)` `ORD`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
StartDate	datetime	Starting date of the campaign. `Required` `Default(Today)` `Filter(ge;le)`

References

Name	Type	Description
AccessKey	AccessKeys (nullable)	The access key, containing the user permissions for this Campaign. Null means that all users have unlimited permissions. `Filter(multi eq)` `Introduced in version 24.1.5.30`

Attribute Details

Description

Campaign description.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

EndDate

End date of the campaign. null means that the end date is still unknown. Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

ForecastedCost

Forecasted total cost of the campaign. Required Default(0)

Type: decimal (18, 0)
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Default Value: 0
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

Indicates whether the current Campaign is active. Required Default(true) Filter(eq) Introduced in version 24.1.5.19

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

Name

Short name of the campaign. Required Filter(like) ORD

Type: string (64)
Indexed: True
Category: System
Supported Filters: Like
Supports Order By: True
Maximum Length: 64
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

StartDate

Starting date of the campaign. Required Default(Today) Filter(ge;le)

Type: datetime
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDate
Show in UI: ShownByDefault

Reference Details

AccessKey

The access key, containing the user permissions for this Campaign. Null means that all users have unlimited permissions. Filter(multi eq) Introduced in version 24.1.5.30

Type: AccessKeys (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: CannotBeShown

Remarks
Supported permissions

Permission	Type
Update	-
Delete	-
Administer (manage security)	-

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST