Campaigns
Maintains marketing campaign records and supports linking to leads, contacts, or deals for engagement tracking.
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 |
A unique identifier (Id) for the campaign. |
| CampaignOwner_Id | String | False |
The Id of the user who owns the campaign. |
| CampaignOwner_FirstName | String | True |
The first name of the user who owns the campaign. |
| CampaignOwner_LastName | String | True |
The last name of the user who owns the campaign. |
| CampaignOwner_Email | String | True |
The email address of the campaign owner. |
| CampaignOwner_Name | String | True |
The full name of the campaign owner. |
| Type | String | False |
The type of the campaign, such as webinar, trade show, or email campaign. |
| CampaignName | String | False |
The name given to the campaign. |
| Status | String | False |
The current status of the campaign, such as Planned, Active, or Completed. |
| StartDate | Date | False |
The date when the campaign begins. |
| EndDate | Date | False |
The date when the campaign ends. |
| ExpectedRevenue | Decimal | False |
The projected revenue expected from the campaign. |
| BudgetedCost | Decimal | False |
The total budget allocated for the campaign. |
| ActualCost | Decimal | False |
The actual amount spent on the campaign. |
| ExpectedResponse | Long | False |
The expected number of responses the campaign aims to receive. |
| Numberssent | Long | False |
The number of individuals the campaign was sent to. |
| CreatedBy_Id | String | False |
The Id of the user who created the campaign. |
| CreatedBy_FirstName | String | True |
The first name of the user who created the campaign. |
| CreatedBy_LastName | String | True |
The last name of the user who created the campaign. |
| CreatedBy_Email | String | True |
The email address of the user who created the campaign. |
| CreatedBy_Name | String | True |
The full name of the user who created the campaign. |
| ModifiedBy_Id | String | False |
The Id of the user who last modified the campaign. |
| ModifiedBy_FirstName | String | True |
The first name of the user who last modified the campaign. |
| ModifiedBy_LastName | String | True |
The last name of the user who last modified the campaign. |
| ModifiedBy_Email | String | True |
The email address of the user who last modified the campaign. |
| ModifiedBy_Name | String | True |
The full name of the user who last modified the campaign. |
| CreatedTime | Datetime | False |
The date and time when the campaign was created. |
| ModifiedTime | Datetime | False |
The date and time when the campaign was last modified. |
| Tag | String | False |
The tags associated with the campaign for categorization or filtering. |
| Description | String | False |
A detailed description of the campaign's purpose or content. |
| ParentCampaign_Id | String | False |
The Id of the parent campaign, if this is a sub-campaign. |
| ParentCampaign_Name | String | True |
The name of the parent campaign, if applicable. |
| LastActivityTime | Datetime | False |
The date and time of the most recent activity related to this 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 |
| DuplicateCheckFields | String |
The fields used to check for duplicate records in an upsert operation. The REST API allows multiple fields while the BULK API allows only one. |
| Trigger | String |
Used to activate automation rules during the insertion of records into the CRM account. |
| CustomViewId | Long |
The custom view Id used to filter this record. Works only when the useCOQL parameter is set to false. |