Campaigns
Tracks marketing campaigns, linking them to leads, contacts, and revenue metrics for ROI analysis.
Table-Specific Information
Select
This table supports the COQL and BULK APIs 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. |
| Owner_Id | String | False |
Identifier of the user who owns the campaign. |
| Owner_FirstName | String | True |
First name of the user who owns the campaign. |
| Owner_LastName | String | True |
Last name of the user who owns the campaign. |
| Owner_Email | String | True |
Email address of the user who owns the campaign. |
| Type | String | False |
Type of the campaign, such as email, advertisement, or event. |
| Campaign_Name | String | False |
Name of the campaign. |
| Status | String | False |
Current status of the campaign, such as planned or completed. |
| Start_Date | Date | False |
Start date of the campaign. |
| End_Date | Date | False |
End date of the campaign. |
| Expected_Revenue | Decimal | False |
Estimated revenue expected from the campaign. |
| Budgeted_Cost | Decimal | False |
Planned cost for executing the campaign. |
| Actual_Cost | Decimal | False |
Total cost incurred during the campaign. |
| Expected_Response | Long | False |
Estimated number of responses to the campaign. |
| Num_sent | Long | False |
Number of messages or invitations sent as part of the campaign. |
| Created_By_Id | String | False |
Identifier of the user who created the campaign record. |
| Modified_By_Id | String | False |
Identifier of the user who last modified the campaign record. |
| Modified_By_FirstName | String | True |
First name of the user who last modified the campaign record. |
| Modified_By_LastName | String | True |
Last name of the user who last modified the campaign record. |
| Modified_By_Email | String | True |
Email address of the user who last modified the campaign record. |
| Created_Time | Datetime | False |
Date and time when the campaign record was created. |
| Modified_Time | 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. |
| Parent_Campaign_Id | String | False |
Identifier of the parent campaign, if the current campaign is part of a larger campaign. |
| Id_CustomModule | Long | True |
Internal record identifier used for reference. |
| Last_Activity_Time | 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 more granular control over the data returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field. |
| Trigger | String |
To trigger the rule while inserting record into CRM account. |