Campaigns
Create, update, delete, and query information regarding campaigns.
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 | False |
The unique identifier for this record. |
| CampaignOwner_Id | String | False |
The Id of the campaign owner. |
| CampaignOwner_FirstName | String | False |
The First Name of the campaign owner. |
| CampaignOwner_LastName | String | False |
The Last Name of the campaign owner. |
| Type | String | False |
The type of the campaign. |
| CampaignName | String | False |
The name of the campaign. |
| Status | String | False |
The status of the campaign. |
| StartDate | Date | False |
The date of the start of the campaign. |
| EndDate | Date | False |
The date of the end of the campaign. |
| ExpectedRevenue | Double | False |
The expected revenue from this campaign. |
| BudgetedCost | Double | False |
The budgeted cost of the campaign. |
| ActualCost | Double | False |
The actual cost of the campaign. |
| ExpectedResponse | Long | False |
The expected response from this campaign. |
| Numberssent | Long | False |
The number of sent campaigns. |
| CreatedBy_Id | String | False |
The Id of the User who created the record. |
| ModifiedBy_Id | String | False |
The Id of the User who modified the record. |
| ModifiedBy_FirstName | String | False |
The First Name of the User who modified the record. |
| ModifiedBy_LastName | String | False |
The Last Name of the User who modified the record. |
| CreatedTime | Datetime | False |
The time when the record was created. |
| ModifiedTime | Datetime | False |
The time when the record was modified. |
| Tag | String | False |
The tags for this campaign. |
| Description | String | False |
The description of 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 |
| Word | String |
Used to search for a specific word in records. |
| DuplicateCheckFields | String |
The field/s to be used for checking in an upsert. |
| Converted | Boolean |
Set to true to return only converted records. |
| Approved | Boolean |
Set to true to return only approved records. |
| CustomViewId | String |
The custom view Id to be used for filtering this record. |