The Labels API allows your third-party software tool to create, delete, and access information relating to labels in your Social Media Management organization.
Note:
This article offers an introduction to the Labels 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.
Labels API endpoints
Note: The information below provides a description of each available endpoint in the Labels API. Please refer to the Social Media Management API Technical Documentation for more information on each available API, parameters, resource IDs, terms of use, and more.
There are four endpoints available in the Labels API:
- Create a Label
- Get a Label
- Search Labels
- Delete a Label
- Create a Label
-
Using the Create a label endpoint, you can add one new label at a time to your Social Media Management organization by simply providing a label name. All new labels can be applied to content and conversations via Publish and Engage by any member of your organization. In addition, all new labels can be managed by Team Leaders and Admins in Settings > Labels management.
- Get a Label
-
Using an existing Label ID, retrieve information about existing labels, such as the label name, creation date, date it was last applied, and number of times it has been applied.
- Search Labels
-
Search for labels by name to retrieve the name, Label ID, creation date, date it was last applied, and number of times it has been applied. You can limit the number of search results per page and specify an order for your results (for example, to appear in alphabetical order or by creation date).
- Delete a Label
-
Using an existing Label ID, you can delete any existing label. Deleting a label will remove it from your Social Media Management organization. Users will no longer be able to apply the label to content or conversations, and Team Leaders and Admins will no longer be able to view the label in Labels management.
Tip:
To find a Label ID for use with the Get a Label or Delete a Label endpoint, first use the Search Labels endpoint.
Benefits of the Labels API
With the Labels API, you may decide to build a custom integration with your contact management software (CMS) or enterprise resource planning (ERP) software to create labels in Social Media Management based on existing keywords or tags that your organization uses.
You could also use the API to search for existing labels in your Social Media Management organization to add to Social Media Management content or external publications.
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.