Create a Marketing Campaign
POST {{base_url}}/campaign
Use this endpoint to create a new marketing campaign in the Marketing Campaigns hub.
Specify the data for the new marketing campaign in the request body. Minimum required data include required fields and defaults from the marketing campaign metadata.
The metadata will have the most up to date details for your instance of Vantagepoint when calling the API using your authenticated environment.
Request
A successful call status of 201 Created returns the JSON representation for the newly created marketing campaign.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
requiredFieldValidation | string | Optional. |
The flag that indicates whether or not the validation for required screen designer fields is needed.
Use "N" if you want to bypass the validation. Otherwise, the default is "Y," which enforces the validation.
NOTE: This does not apply to required system fields. |
| startWorkflow | string | | Optional.
The flag that indicates whether or not the trigger for a workflow is initiated.
Use "N" if you want to bypass the trigger. Otherwise, the default is "Y," which initiates the workflow. |
Request Body
[{"name"=>"CampaignID", "value"=>"String", "datatype"=>"string"}, {"name"=>"Name", "value"=>"String", "datatype"=>"string"}, {"name"=>"Description", "value"=>"String", "datatype"=>"string"}, {"name"=>"Number", "value"=>"String", "datatype"=>"string"}, {"name"=>"WBS1", "value"=>"String", "datatype"=>"string"}, {"name"=>"WBS1Name", "value"=>"String", "datatype"=>"string"}, {"name"=>"PotentialResponses", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"CustomCurrencyCode", "value"=>"String", "datatype"=>"string"}, {"name"=>"Org", "value"=>"Org", "datatype"=>"string"}, {"name"=>"OrgName", "value"=>"String", "datatype"=>"string"}, {"name"=>"emCampaignMgr", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"emCampaignMgrFL", "value"=>"String", "datatype"=>"string"}, {"name"=>"emCampaignMgrPhone", "value"=>"String", "datatype"=>"string"}, {"name"=>"emCampaignMgrEmail", "value"=>"String", "datatype"=>"string"}, {"name"=>"emCampaignMgrTitle", "value"=>"String", "datatype"=>"string"}, {"name"=>"emCampaignMgrLocation", "value"=>"String", "datatype"=>"string"}, {"name"=>"CampaignMgr", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"emMarketingMgr", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingMgrFL", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingMgrPhone", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingMgrEmail", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingMgrTitle", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingMgrLocation", "value"=>"String", "datatype"=>"string"}, {"name"=>"MktgMgr", "value"=>"Employee", "datatype"=>"string"}, {"name"=>"emMarketingCoordinator", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingCoordinatorFL", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingCoordinatorPhone", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingCoordinatorEmail", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingCoordinatorTitle", "value"=>"String", "datatype"=>"string"}, {"name"=>"emMarketingCoordinatorLocation", "value"=>"String", "datatype"=>"string"}, {"name"=>"Manager3", "value"=>"String", "datatype"=>"string"}, {"name"=>"FirstAction", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"CurrentAction", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"NextAction", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"HasPhoto", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"PhotoModDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"LaunchDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"EndDate", "value"=>"Date", "datatype"=>"string"}, {"name"=>"RecordStatus", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Status", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Type", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Audience", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Objective", "value"=>"Dropdown", "datatype"=>"string"}, {"name"=>"Revenue", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"Budget", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"ActualCost", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"Responses", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"PctResponses", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"Projects", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"QualifiedContacts", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"QualifiedClients", "value"=>"Numeric", "datatype"=>"string"}, {"name"=>"CreateUser", "value"=>"String", "datatype"=>"string"}, {"name"=>"CreateDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"ModUser", "value"=>"String", "datatype"=>"string"}, {"name"=>"ModDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"ExchangeRateDate", "value"=>"Datetime", "datatype"=>"string"}, {"name"=>"ActualRevenue", "value"=>"Currency", "datatype"=>"string"}, {"name"=>"PotentialRevenue", "value"=>"Currency", "datatype"=>"string"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
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: Created
[{"CampaignID":"216CD9C1382B445ABC9994D715842BAD","Name":"Design 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":"BO: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","emMarketingCoordinatorPhone":"617","emMarketingCoordinatorEmail":"email@company.com","emMarketingCoordinatorTitle":"Project Manager","emMarketingCoordinatorLocation":"Boston Architecture","Manager3":"00201","FirstAction":"01","CurrentAction":"03","NextAction":"04","HasPhoto":0,"PhotoModDate":"","LaunchDate":"2003-07-21T00:00:00.000","EndDate":"2003-09-25T00:00:00.000","RecordStatus":"A","Status":"01","Type":"03","Audience":"02","Objective":"01","Revenue":0,"Budget":10000,"ActualCost":9360,"Responses":0,"PctResponses":0,"Projects":"","QualifiedContacts":"","QualifiedClients":"","CreateUser":"William Apple, PE","CreateDate":"2018-01-29T19:17:13.787","ModUser":"William Apple, PE","ModDate":"2018-01-29T19:17:13.787","ExchangeRateDate":"","ActualRevenue":0,"PotentialRevenue":0}]