In addition, you can also use the Campaign API to create campaigns, update and delete existing campaigns, and add or remove existing stock items in campaigns.
Note: This article offers an introduction to the Social Media Management Campaign API. For developer information, please visit Social Media Management's API Technical Documentation. Visit our article on Getting Access to Social Media Management APIs for first-time steps.
Campaign API endpoints
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
Finding a 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 Social Media Management
In Social Media Management, 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.
Finding a 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 Social Media Management
In Social Media Management, 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.
Benefits of the Campaign API
Often used with a Digital Asset Management (DAM) system, you may decide to push content directly from your DAM system directly to a Social Media Management campaign. Once you push assets to your campaigns, content creators may subsequently utilize the assets when creating future posts in Publish.
Accessing technical documentation
For general information about the features of our available APIs, check out our Introduction to APIs section. To view technical documentation for each Social Media Management API, please visit: falconio.docs.apiary.io.