JDBC Driver for SuiteCRM

Build 22.0.8462

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 Name = 'campaign name'

Insert

Create a Campaign by specifying any writable column.

INSERT INTO Campaigns(Id, Name) VALUES('id', 'Energy')

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.

Name String False

The name of the campaign.

DateEntered Datetime False

The date the record was created.

DateModified Datetime False

The date the record was last modified.

ModifiedUserId String False

The Id of the user who last modified the record.

ModifiedByName String True

The name of the user who last modified the record.

CreatedBy String False

The Id of the user who created the record.

CreatedByName String True

The name of the user who created the record.

Description String False

The description for the campaign.

Deleted Bool False

The record deletion indicator.

CreatedByLink String True

Link to the record who created it

ModifiedUserLink String True

Link to the record who modified it.

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.

AssignedUserLink String True

Link to the user which the record has been assigned to

SecurityGroups String True

The security group associated with the record.

TrackerKey String False

TrackerCount String False

The number of accesses made to the tracker URL; no longer used as of 4.2. (See CampaignTrackers.)

ReferUrl String False

TrackerText String False

StartDate String False

Starting date of the campaign.

EndDate String False

Ending date of the campaign.

Status String False

The status of the record.

Impressions String False

Expected click throughs manually entered by the campaign manager.

CurrencyId String False

Budget String False

Budgeted amount for the campaign.

ExpectedCost String False

Expected cost of the campaign.

ActualCost String False

Actual cost of the campaign.

ExpectedRevenue String False

Expected revenue stemming from the campaign.

CampaignType String False

Objective String False

The objective of the campaign.

Content String False

The campaign description.

Prospectlists String True

Emailmarketing String True

Queueitems String True

LogEntries String True

TrackedUrls String True

Frequency String False

Frequency of the campaign.

Leads String True

The leads associated with the record.

Opportunities String True

The opportunities associated with the record.

Contacts String True

The contacts associated with the record

Accounts String True

The accounts associated with the record

Survey String True

SurveyName String True

SurveyId String False

SurveyresponsesCampaigns String True

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462