Campaign API Introduction

The Campaign API allows your third-party software to access information relating to all existing Publish Campaigns in your Falcon organization. In addition, you can also use the Campaign API to create Campaigns, update and delete existing Campaigns, and add or remove existing template items (otherwise known as stock items in Falcon) to Campaigns.

Note:

This article offers an introduction to the Falcon Campaign API. For more information, please visit Falcon’s API Technical Documentation here. Don’t yet have access to Falcon APIs? Find out how to get access here.

What Features are Available?

There are eight endpoints available in the Campaign API:

  • Create Campaign
  • Get All Campaigns
  • Get Campaign by ID
  • Get Campaigns by Resource IDs
  • Update Campaign
  • Delete Campaign
  • Add Template to Campaign
  • Delete Attachment from Campaign
Create Campaign

Using the Create Campaign endpoint, you can create new Publish Campaigns which will appear on the Publish Calendar for your organization.

When you’re creating the campaign, you must include the title for the campaign, the color (as it will appear on the calendar), the included Falcon Teams, the start and end date, and a user to receive a reminder. In addition, you have the option to include a Campaign description, time zone, and any existing or new stock items.

Get All Campaigns
Use this endpoint to retrieve all existing Campaigns. Results can be filtered by Teams, time range, and labels. The returned data contains information about the Campaign title, description, reminders, assigned teams, labels, and start and end dates.
Please bear in mind that results will not return the stock items attached to the Campaigns.
Get Campaign by ID

The Get Campaign by ID endpoint will return information on any single specific Campaign. Please see below for information on how to obtain a particular Campaign ID.

The returned data will contain the Campaign title, description, reminders, assigned teams, labels, the start and end dates, and any stock items attached to the Campaign.

Get Campaigns by Resource IDs

Find out which Campaigns are associated with a particular stock item. Please see below for information on how to obtain the ID of a stock item.

Results will return the name and IDs of any applicable Campaigns associated with the stock item.

Update Campaign
Using the ID of any existing Campaign, you can update the Campaign’s title, color on the Falcon calendar, teams, the start and end dates, and reminders.
Delete Campaign

Using the ID of any existing Campaign, you can choose to delete the Campaign entirely.

Add Template to Campaign
Using the ID of a template (stock) item from the Content Pool, you can add it to an existing Campaign by specifying the Campaign ID.
Delete Attachment from Campaign

Using both the existing attachment (stock) item ID and the existing Campaign ID, you can use this endpoint to remove the item from the Campaign.

How Can I Find My Campaign ID?

To update or find information on any specific Campaign, you will first need the Campaign ID. There are two ways to find your Campaign ID.

Via the Campaign API

Using the Get All Campaigns endpoint, your results will include information relating to all existing Campaigns, including the Campaign ID for each.

Via the Flacon Platform

In Falcon, any user with access to the Campaign on the Publish Calendar can click to view more information about the Campaign. The Campaign ID will be visible in the URL as shown below.

mceclip0.png

How Can I Find My Stock ID?

To use either the Add Template to Campaign or Delete Attachment from Campaign endpoints, you will first need the Stock ID of an existing Stock item. There are two ways to locate an existing Stock ID.

Via the Content Pool API

Using the Search Stocks endpoint of the Content Pool API, you can use various criteria to search through all existing stock items in the Content Pool. Matching results will contain information about each stock item including the Stock ID.

Via the Falcon Platform

In Falcon, any user with access to the Content Pool or any applicable Campaigns on the Publish Calendar can click to open and view existing stock items. In the editor, the Stock ID will appear in the URL as shown below.

mceclip1.png

How Can I Use the Campaign API?

Often used with a Digital Asset Management (DAM) system, you may decide to incorporate a folder with your Falcon Campaigns, allowing you to push content directly to Falcon Campaigns. Once assets are pushed to Falcon Campaigns, content creators may subsequently utilize the assets when creating new posts relating to the correct Campaigns.

Where Can I Find the Technical Documentation?

For general information and descriptions of the available APIs, check out the Help Center guides here. To view the Falcon API Technical Documentation, please visit: falconio.docs.apiary.io

Was this article helpful?
0 out of 0 found this helpful