Home > Application Reference > Percolate > Create Campaign

This action allows you to create a new campaign.

You can find the API details here.

Options:

  • Tenant (dropdown): dynamically generated list of tenants to choose from
  • Team (dropdown): dynamically generated list of teams to choose from

Inputs:

  • Fields
    • Title (string): Title or Description must be provided
    • Description (string): Title or Description must be provided
    • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
    • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
    • Budget Currency (string): Standard currencies defined by ISO_4217
    • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
    • Term IDs (collection): An array of the terms associated with the campaign
    • Assignee ID (string): The ID of user who is assigned to the campaign
    • Approval Group ID (string): The approval group ID
    • Copy From ID (string): Creates a copy of the specified campaign when a campaign UID is specified or creates a campaign from a campaign template when a campaign template UID is specified
    • Copy Section Types (collection): Copy campaign sections matching given types
    • Platform IDs (collection): An array of the platforms associated with the campaign
    • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
    • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
    • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
    • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID

Outputs:

  • Campaign
    • Campaign ID (string): The unique campaign ID
    • Team ID (string): A license ID
    • Title (string): The campaign title
    • Description (string): A short description of the campaign
    • Start At (string): The date when the campaign is scheduled to start, e.g. 2019-01-01
    • End At (string): The date when the campaign is scheduled to end, e.g. 2020-01-01
    • Budget Currency (string): Standard currencies defined by ISO_4217
    • Budget Amount (string): Budget Currency and Budget Amount must be specified together if you want to provide budget info
    • Term IDs (string): An array of the terms associated with the campaign
    • Assignee ID (string): The ID of user who is assigned to the campaign
    • Created At (string): An absolute datetime indicating when this resource was created
    • Updated At (string): An absolute datetime indicating when this resource was last modified
    • Ordinal (string): Default ordering of the task relative to others with the same subject
    • Parent ID (string): The unique campaign ID
    • Root ID (string): The unique campaign ID
    • Platform IDs (collection): An array of the platforms associated with the campaign
    • Post Workflow IDs (collection): An array of the production workflows associated with the campaign
    • Production Workflow ID (string): ID of the production workflow that the campaign is attached to
    • Production Workflow IDs (collection): An array of the production workflows associated with the campaign
    • Thumbnail Asset ID (string): An asset ID, a legacy video ID or a legacy image ID
    • Topic IDs (collection): An array of the topics associated with the campaign
    • Approval IDs (collection): An array of approval IDs