Campaigns
Create, update, delete, and query the SuiteCRM project's campaigns
Table Specific Information
Select
You can query the Campaigns table using any criteria in the WHERE clause. The driver will use the SuiteCRM API to filter the results.
SELECT * FROM Campaigns WHERE Budget < 10000
Insert
Create a Campaign by specifying any writable column.
INSERT INTO Campaigns (Name,[Expected Cost],[Actual Cost]) VALUES ('Suite Campaign',30000,29400)
Update
You can update any Campaign column that is writable, by specifying the Id.
UPDATE Campaigns SET Budget = 30000 WHERE Id = 'Test123'
Delete
Delete a Campaign by specifying the Id.
DELETE FROM Campaigns WHERE Id = '10003'
Columns
Name | Type | ReadOnly | Description |
ID [KEY] | String | False |
The unique identifier of the campaign. |
ActualCost | Double | False |
Actual cost of the campaign. |
AssignedUserId | String | False |
The Id of the user assigned to the record. |
AssignedUserName | String | True |
The user name of the user assigned to the record. |
Budget | Double | False |
Budgeted amount for the campaign. |
Content | String | False |
The campaign description. |
CreatedById | String | True |
The Id of the user who created the record. |
CreatedByName | String | True |
The name of the user who created the record. |
Currency | String | False |
Currency in use for the campaign. |
DateCreated | Datetime | True |
The date the record was created. |
DateModified | Datetime | True |
The date the record was last modified. |
Deleted | Bool | False |
The record deletion indicator. |
Description | String | True |
The description for the campaign. |
EndDate | Date | False |
Ending date of the campaign. |
ExpectedCost | Double | False |
Expected cost of the campaign. |
ExpectedRevenue | Double | False |
Expected revenue stemming from the campaign. |
Frequency | String | False |
Frequency of the campaign. |
Impressions | Int | False |
Expected click throughs manually entered by the campaign manager. |
ModifiedById | String | True |
The Id of the user who last modified the record. |
ModifiedByName | String | True |
The name of the user who last modified the record. |
Name | String | False |
The name of the campaign. |
Objective | String | False |
The objective of the campaign. |
StartDate | Date | False |
Starting date of the campaign. |
Status | String | False |
Status of the campaign. |
Tracker | Int | False |
The internal Id of the tracker used in a campaign. 2. (See CampaignTrackers.) |
TrackerCount | Int | False |
The number of accesses made to the tracker URL; no longer used as of 4.2. (See CampaignTrackers.) |
TrackerLinkText | String | False |
The text that appears in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.) |
TrackerRedirectURL | String | False |
The URL referenced in the tracker URL. No longer used as of 4.2. (See CampaignTrackers.) |
Type | String | False |
The type of the campaign. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Rows@Next | String |
Identifier for the next page of results. Do not set this value manually. |