Templates

Create a template

Requires scope campaigns:write.

post/api/v1/templates

Request

Base URL: https://getscaleforge.com
URL: https://getscaleforge.com/api/v1/templates
Auth: HTTP bearer

Request body

namestring

productstring

objectivestring

statusstring

daily_budgetnumber

audience_namestring

age_mininteger

age_maxinteger

gendersstring

bid_strategystring

start_bidnumber

bid_stepnumber

bid_countinteger

primary_textstring

headlinestring

link_urlstring uri

ctastring

page_idstring

pixel_idstring

conversion_eventstring

budget_optimization'CBO' | 'ABO'

naming_templatestring

url_tagsstring

include_bid_in_nameboolean

geo_locationsstring[]

placementsstring[]

interestsobject[]

custom_audiencesstring[]

exclusionsobject[]

device_platformsstring[]

languagesstring[]

publisher_platformsstring[]

Example request

{
  "objective": "OUTCOME_SALES",
  "status": "ACTIVE",
  "daily_budget": 100,
  "age_min": 18,
  "age_max": 55,
  "genders": "all",
  "bid_strategy": "LOWEST_COST_WITH_BID_CAP",
  "start_bid": 4.4,
  "bid_step": 0.05,
  "bid_count": 5,
  "cta": "LEARN_MORE",
  "conversion_event": "Purchase"
}

Response

Template created

Example response

{
  "data": {
    "id": 12,
    "name": "US-Desktop-Purchase",
    "product": "SweepstakesOffer",
    "objective": "OUTCOME_SALES",
    "status": "ACTIVE",
    "daily_budget": 100,
    "audience_name": "US 18-55 Interests",
    "age_min": 18,
    "age_max": 55,
    "genders": "all",
    "bid_strategy": "LOWEST_COST_WITH_BID_CAP",
    "start_bid": 4.4,
    "bid_step": 0.05,
    "bid_count": 5,
    "cta": "LEARN_MORE",
    "conversion_event": "Purchase",
    "geo_locations": [
      "US",
      "CA"
    ],
    "budget_optimization": "CBO",
    "naming_template": "{product}_{geo}_{bid}",
    "times_used": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.