Marketing Campaign
GET {{base_url}}/campaign/:CampaignID
Use this endpoint to retrieve a single marketing campaign from the Marketing Campaigns hub by specifying the campaign ID.
Response
| FieldName | Description |
|---|---|
| CampaignID | Unique identifier for the campaign record |
| Name | Name of the marketing campaign |
| Description | Text describing the marketing campaign. Text includes formatting tags. |
| Number | User entered (new) or system populated (existing) identifier for the marketing campaign record |
| WBS1 | Project number for the project associated with the marketing campaign |
| WBS1Name | Project name |
| PotentialResponses | Number of possible responses to the marketing campaign |
| CustomCurrencyCode | Three digit code that a user chooses to define the type of currency used. Valid values from CodeTable: FW_CFGCurrency. |
| Org | Client defined value that defines the organization up to 5 sublevels. Each level is two characters and are each separated by a user-defined delimiter. Sample valid values SF:AR:00:TS, BO:EN, CO:00, DC:AD. |
| OrgName | Name of the organization |
| emCampaignMgr | Last name, First name of the employee who is the campaign manager for the marketing campaign |
| emCampaignMgrFL | Full name (including suffix when available) of the employee who is the campaign manager |
| emCampaignMgrPhone | Phone number of the employee who is the campaign manager |
| emCampaignMgrEmail | Email of the employee who is the campaign manager |
| emCampaignMgrTitle | Title of the employee who is the campaign manager |
| emCampaignMgrLocation | Office or branch where the campaign manager is physically located at or associated with |
| CampaignMgr | Employee ID for the campaign manager |
| emMarketingMgr | Last name, First name of the employee who is the marketing manager |
| emMarketingMgrFL | Full name (including suffix when available) of the employee who is the marketing manager |
| emMarketingMgrPhone | Phone number of the employee who is the marketing manager |
| emMarketingMgrEmail | Email of the employee who is the marketing manager |
| emMarketingMgrTitle | Title of the employee who is the marketing manager |
| emMarketingMgrLocation | Office or branch where the marketing manager is physically located at or associated with |
| MktgMgr | Employee ID for the marketing manager |
| emMarketingCoordinator | Last name, First name of the employee who is the marketing coordinator |
| emMarketingCoordinatorFL | Full name (including suffix when available) of the employee who is the marketing coordinator |
| emMarketingCoordinatorPhone | Phone number of the employee who is the marketing coordinator |
| emMarketingCoordinatorEmail | Email of the employee who is the marketing coordinator |
| emMarketingCoordinatorTitle | Title of the employee who is the marketing coordinator |
| emMarketingCoordinatorLocation | Office or branch where the marketing coordinator is physically located at or associated with |
| Manager3 | Employee ID of a third manager for the marketing campaign |
| FirstAction | Initial campaign action completed |
| CurrentAction | Current campaign action |
| NextAction | Campaign action that will happen next |
| HasPhoto | 0 or 1. 0 - The object does not have a photo. 1 - The object does have a photo. |
| PhotoModDate | Date and timestamp of when the contact photo was updated |
| LaunchDate | Date and timestamp of the marketing campaign start |
| EndDate | Date and timestamp of the marketing campaign end |
| RecordStatus | The status of the marketing campaign record. Valid values from CodeTable: CFGCampaignRecStatus. |
| Status | Status of the employee. Afor Active. Ifor Inactive. Tfor Terminated. Default: A. Sample valid values A, I, Tfrom CodeTable: CFGEmployeeStatus. |
| Type | Marketing campaign type. Valid values from CodeTable: CFGCampaignType. |
| Audience | Target market segment to which the marketing campaign is directed. Sample values: CFOs, Marketing and Sales, or Project Managers, for example. Valid values from CodeTable: CFGCampaignAudience. |
| Objective | Main goal of the marketing campaign. Valid values from CodeTable: CFGCampaignObjective. |
| Revenue< | Revenue the marketing campaign is expected to generate |
| Budget | Amount of money allocated to spend on the marketing campaign |
| ActualCost | Amount of money for the marketing campaign expenses |
| Responses | How many marketing campaign contact recipients responded |
| PctResponses | User entered or provided number of total potential responses to the marketing campaign |
| Projects | Number of leads for which the marketing campaign can provide opportunities |
| QualifiedContacts | Number of contacts from the marketing campaign whose lead status changed from new to qualified |
| QualifiedClients | Number of clients from the marketing campaign whose lead status changed from new to qualified |
| CreateUser | Name of the person who created the new record |
| CreateDate | Date and timestamp when the new record was created |
| ModUser | Name of the person who modified an existing record of this type |
| ModDate | Date and timestamp when the existing record of this type was modified |
| ExchangeRateDate | Date and timestamp of the exchange rate used to calculate financials. This field displays if Vantagepoint is set up to use multiple currencies. |
| ActualRevenue | If Vantagepoint uses the Accounting application, this field is a calculated field that sums up the Compensations fields for all projects associated with the marketing campaign. If the Accounting application is not in use, this field is a result of the user provided dollar amount for actual revenue. |
| PotentialRevenue | This field is automatically calculated to display the sum of the estimated revenue (not weighted revenue) of all Active opportunities that are associated with the marketing campaign. This field does not include inactive opportunities because they were either won and included in the actual cost, or they were lost or not pursued. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
CampaignID | null | Identifier of the marketing campaign you want to read | |
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: OK
[{"CampaignID":"ADMIN1059050412878","Name":"Design and Construction Best Practices Seminar","Description":"Seminar to discuss what firms face when designing and developing new facilities.","Number":"M-0012","WBS1":"00000P5.00","WBS1Name":"Business Development","PotentialResponses":3000,"CustomCurrencyCode":"USD","Org":"PR:00:CO:00","OrgName":"Corporate","emCampaignMgr":"Cohen, Grace","emCampaignMgrFL":"Grace Cohen, AIA","emCampaignMgrPhone":"617","emCampaignMgrEmail":"gcoehn@applebartlett.com","emCampaignMgrTitle":"Interior Designer","emCampaignMgrLocation":"Boston Architecture","CampaignMgr":"00003","emMarketingMgr":"Johnson, Ann","emMarketingMgrFL":"Ann Johnson","emMarketingMgrPhone":"415","emMarketingMgrEmail":"amjohnson@applebartlett.com","emMarketingMgrTitle":"Project Manager","emMarketingMgrLocation":"San Fran Admin","MktgMgr":"00026","emMarketingCoordinator":"Anderson, Steve","emMarketingCoordinatorFL":"Steve Anderson, AIA","emMarketingCoordinatorPhone":"617","emMarketingCoordinatorEmail":"email@company","emMarketingCoordinatorTitle":"Project Manager","emMarketingCoordinatorLocation":"Boston Architecture","Manager3":"00201","FirstAction":"01","CurrentAction":"03","NextAction":"04","HasPhoto":0,"PhotoModDate":"","LaunchDate":"2007-07-21T00:00:00.000","EndDate":"2007-09-25T00:00:00.000","RecordStatus":"A","Status":"I","Type":"03","Audience":"02","Objective":"01","Revenue":0,"Budget":10000,"ActualCost":9360,"Responses":12,"PctResponses":0,"Projects":4,"QualifiedContacts":2,"QualifiedClients":1,"CreateUser":"Billy Boy Charles, Jr.","CreateDate":"2007-07-24T12:45:15.000","ModUser":"Billy Boy Charles, Jr.","ModDate":"2007-09-04T17:45:25.000","ExchangeRateDate":"","ActualRevenue":0,"PotentialRevenue":0}]