Campaigns
Tracks marketing campaigns, linking them to leads, contacts, and revenue metrics for ROI analysis.
Table-Specific Information
Select
This table supports COQL for filtering, meaning that most filters comparing columns to values are submitted server-side.
Insert
INSERT INTO Campaigns (CampaignName) VALUES ('a test campaign')
Required fields: CampaignName.
Any field which is not read-only (ReadOnly = false in the table below) can be inserted.
Delete
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Campaigns WHERE Id = '3152079000000485001'
Update
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Campaigns SET CampaignName = 'Updated from API' WHERE Id = '3152079000000485001'
Required fields: Id.
Any field which is not read-only (ReadOnly = false in the table below) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier for the campaign. |
| CampaignOwner_Id | String | False |
Identifier of the user who owns the campaign. |
| CampaignOwner_FirstName | String | True |
First name of the user who owns the campaign. |
| CampaignOwner_LastName | String | True |
Last name of the user who owns the campaign. |
| CampaignOwner_Email | String | True |
Email address of the user who owns the campaign. |
| CampaignOwner_Name | String | True |
Full name of the user who owns the campaign. |
| Type | String | False |
Type of the campaign, such as email, advertisement, or event. |
| CampaignName | String | False |
Name of the campaign. |
| Status | String | False |
Current status of the campaign, such as planned or completed. |
| StartDate | Date | False |
Start date of the campaign. |
| EndDate | Date | False |
End date of the campaign. |
| ExpectedRevenue | Decimal | False |
Estimated revenue expected from the campaign. |
| BudgetedCost | Decimal | False |
Planned cost for executing the campaign. |
| ActualCost | Decimal | False |
Total cost incurred during the campaign. |
| ExpectedResponse | Long | False |
Estimated number of responses to the campaign. |
| Numberssent | Long | False |
Number of messages or invitations sent as part of the campaign. |
| CreatedBy_Id | String | False |
Identifier of the user who created the campaign record. |
| CreatedBy_FirstName | String | True |
First name of the user who created the campaign record. |
| CreatedBy_LastName | String | True |
Last name of the user who created the campaign record. |
| CreatedBy_Email | String | True |
Email address of the user who created the campaign record. |
| CreatedBy_Name | String | True |
Full name of the user who created the campaign record. |
| ModifiedBy_Id | String | False |
Identifier of the user who last modified the campaign record. |
| ModifiedBy_FirstName | String | True |
First name of the user who last modified the campaign record. |
| ModifiedBy_LastName | String | True |
Last name of the user who last modified the campaign record. |
| ModifiedBy_Email | String | True |
Email address of the user who last modified the campaign record. |
| ModifiedBy_Name | String | True |
Full name of the user who last modified the campaign record. |
| CreatedTime | Datetime | False |
Date and time when the campaign record was created. |
| ModifiedTime | Datetime | False |
Date and time when the campaign record was last modified. |
| Tag | String | False |
Tags associated with the campaign record. |
| Description | String | False |
Detailed description of the campaign. |
| ParentCampaign_Id | String | False |
Identifier of the parent campaign, if the current campaign is part of a larger campaign. |
| ParentCampaign_Name | String | True |
Name of the parent campaign, if applicable. |
| RecordId | Long | True |
Internal record identifier used for reference. |
| LastActivityTime | Datetime | False |
Timestamp of the last activity on the campaign record. |
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 |
| DuplicateCheckFields | String |
Fields used to check for duplicates during upsert operations. The REST API supports multiple fields, while the BULK API supports only one. |
| Trigger | String |
Used to trigger automation rules when inserting the campaign record into the CRM. |
| CustomViewId | Long |
Custom view identifier for filtering the campaign record. Works when the useCOQL parameter is set to false. |