Labels APIs

Like categories and subcategories, labels enable your users to filter and locate articles that are relevant to specific topics. You can use labels to control whether or not to display certain articles; see Including and Excluding Articles in Your Help Center.

You can also use labels to filter and locate tickets.

Get Labels

GET https://<tenant_subdomain>.wixanswers.com/api/v1/labels

Get all labels and their information.
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/labels
Request Example Using curl:
1
curl -X GET https://<tenant_subdomain>.wixanswers.com/api/v1/labels -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json'

Get a Label

GET https://<tenant_subdomain>.wixanswers.com/api/v1/labels/{labels GUID}

Get a label and its information.

Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/labels/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a

Add Label

POST https://<tenant_subdomain>.wixanswers.com/api/v1/labels

Add a label. Label names must be unique in the tenant.
Payload Params
Description
Type
Required
name
Label name

Must be unique in the tenant.
String, between 1 and 80 characters
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/labels

{
    "name":"programming"
}

Delete Label

DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/labels/{label GUID}

Delete label. The label is removed from all associated items.

  • Authorization: Requires admin authorization level
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Request Params
Description
Type
permanentDelete
Whether to delete the label permanently. If not deleted permanently, the label can be restored (see Restore Deleted Label). The default is false
Boolean
Request Example:
1
DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/labels/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a
Request Example Using curl:
1
curl -X DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/labels/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json'

Restore Deleted Label

POST https://<tenant_subdomain>.wixanswers.com/api/v1/labels/{label GUID}/restore

Restore a previously-deleted label, if it was not deleted permanently. The label is restored and available, but Wix Answers does not re-associate the label to any items. For example, if the label was associated to an article before the label was deleted, restoring the label does not re-associate the label to that article.

  • Authorization: Requires admin authorization level
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Request Example:
1
POST https://<tenant_subdomain>.wixanswers.com/api/v1/labels/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/restore

Update Label

PUT https://<tenant_subdomain>.wixanswers.com/api/v1/labels/{label GUID}

Change label name. See Important Information about Updating Using the API.

  • Authorization: Requires admin authorization level
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None
Payload Params
Description
Type
Required
name
Label name
String, between 1 and 80 characters
Payload Example:
1
2
3
4
5
PUT https://<tenant_subdomain>.wixanswers.com/api/v1/labels/d367738e-368e-41fe-9289-1a5cbbc3c239

{
    "name":"Java"
}

Sort Labels

POST https://<tenant_subdomain>.wixanswers.com/api/v1/labels/sort

Sort display of labels according to the specified order.

  • Authorization: Requires admin authorization level
  • Content type: application/json; charset=utf-8
  • Accept: application/json
  • Response: None.
Payload Params
Description
Type
Required
ids
List of labels in the desired sort order

If you do not include one or more label ids, the ones that you include are sorted in the specified order and appear before the other (not included) ids.
List of GUIDs
Payload Example:
1
2
3
4
5
POST https://<tenant_subdomain>.wixanswers.com/api/v1/labels/sort

{
    "ids":["e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a","bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa","77bc8694-5ccf-436c-ab2b-543563a5f425"]
}

Related Articles

Including and Excluding Articles in Your Help Center

Every article you publish is displayed in your Help Center by default. However, you may want to hide some articles that are not meant for your Help Center. For example, you should exclude articles created specifically for widgets or for internal linking purposes. Select an option to learn more:Display content by languageHover over Settings in the side panel and click Help Center.Click the Advanced tab.Click the toggle next to each language to enable or disable it:Enabled: Content in that language appears in your Help Center.Disabled: Content in that language does not appear in your Help Center.Display content by categoryHover over Settings in the side panel and click Help Center.Click the Advanced tab.Click Edit content visibility on the relevant language.Select Use articles from certain categories.Click the Expand arrow and select an option:Use articles from these categories: Select the categories you do want to use. Content in all categories except those: Select the categories that you do not want to use.Click Save.(If applicable) Repeat steps 3 - 6 for each language in your Help Center.Display content by labelYou can create a label and apply it to any article. Then show or hide articles that have a particular label.Hover over Settings in the side panel and click Help Center.Click the Advanced tab.Click Edit content visibility next to the relevant language. Select Use articles with the following labels under Filter content by Labels.Click the relevant drop-down and select labels to:Include ANY of these labels: Articles are included in the Help Center if they have any of the selected labels.Include ALL these labels: Articles are only included in the Help Center if they have all of the selected labels. Exclude: Articles are excluded from the Help Center if they have the selected labels. Click Save.(If applicable) Repeat steps 3 - 6 for each language in your Help Center.Display content by article typeHover over Settings in the side panel and click Help Center.Click the Advanced tab.Click Edit content visibility on the relevant language.Select Use only the following types of articles.Select the article types that you do want to use. Click Save.(If applicable) Repeat steps 3 - 6 for each language in your Help Center.

2 min read

Adding Labels to Tickets Using Automatic Actions

Labels can help identify and categorize incoming tickets. You can automatically add labels to tickets based on conditions you define with Automatic Actions. Then filter your labeled tickets into custom ticket views to keep your Ticketing System organized and easily managed. To add labels to tickets using Automatic Actions: Hover over Settings in the side panel and click Automatic Actions.  Click + Create New Action. Note: Click Start Now then click Create New Action if this is your first Automatic Action. Enter a name for the action. (Optional) Enter a description of the action. Click the toggle(s) under Apply action when to apply the action when: A new ticket is created: The action applies when a new ticket is created.  A user replies: The action applies when a customer replies.  Set the conditions that will cause the action to occur:  ANY of these conditions occur: Set the action that occurs if ANY of the conditions are met:  Click the drop-down menu and select a condition. Click the Operator drop-down menu and select an option (e.g. Is, Is Not). Note: If you selected User is authenticated or a Checkbox custom field type, click Yes or No and skip the next step.  Enter the value that the condition must meet.  (Optional) Click Add Another Condition to add another condition then repeat the steps.   ALL of these conditions occur: Set the action that occurs only if ALL of the conditions are met:  Click the drop-down menu and select a condition. Click the Operator drop-down menu and select an option (e.g. Is, Is Not). Note: If you selected User is authenticated or a Checkbox custom field type, click Yes or No and skip the next step.  Enter the value that the condition must meet.  (Optional) Click Add Another Condition to add another condition then repeat the steps. Click the drop-down menu under Select an action and select Set labels. Click the Select labels field and enter the relevant label. Click Save.

2 min read

Showing or Hiding Help Center Articles with Specific Labels

Labels help you organize your Help Center content. You can set your Help Center to display articles with certain labels and hide articles with others. To choose which labels appear in your Help Center:Hover over Settings in the side panel.  Hover over Help Center and click Advanced.Click Edit content visibility next to the relevant language. Select Use articles with the following labels under Filter content by Labels.Click the relevant drop-down and select labels to:Include ANY of these labels: Articles are included in the Help Center if they have any of the selected labels.Include ALL these labels: Articles are only included in the Help Center if they have all of the selected labels. Exclude: Articles are excluded from the Help Center if they have the selected labels. Click Save.(If applicable) Repeat steps 3 - 6 for each language in your Help Center.

1 min read

Adding and Removing Labels in Articles

Add labels to articles for additional layers of categorization. You can use labels to choose which articles appear in your Help Center or Widgets. You can also add the label filter to your Knowledge Base to view articles by label. To add or remove a label in an article:Go to the article's Content Editor. Click Labels in the footer. Choose what you want to do:Add a new label to the articleClick the drop-down menu and enter a label name. Click Add new label.Click Update. Note: Repeat these steps to add more than one label to the article. Add an existing label to the articleClick the drop-down menu and start typing the name of a label. Select the label from the list.Click Update. Note: Repeat these steps to add more than one label to the article. Remove a label from the articleClick the X icon  next to the label.Click Update. Tip:Click Manage Labels to go to your Label Manager. You can then rename, delete, or click to view all the articles that have a specific label. Learn how to:Use labels to show or hide articles in your Help Center.Use labels to show or hide articles in your Widgets. Add the label filter to show or hide articles in your Knowledge Base list. 

2 min read

Viewing Tickets by Labels

You can add labels to tickets manually or with Automatic Actions to categorize them. Then, add the Labels filter to a view on your Tickets List to display tickets with or without specific labels. To view tickets by labels:Click the Tickets icon in the side panel.Hover over the view you'd like to filter and click Edit.Click Add Filter.Click Labels.Click a filter option drop-down: Include Any: Include tickets with any of the selected label(s). For example, if you select the labels &quot;New&quot; and &quot;Urgent,&quot; tickets with either the &quot;New&quot; or &quot;Urgent&quot; labels display.Include All: Include tickets with all of the selected label(s). For example, if you select the labels &quot;New&quot; and &quot;Urgent,&quot; tickets with both the &quot;New&quot; and &quot;Urgent&quot; labels display.Exclude Any: Include tickets that do not have the selected label(s). For example, if you select the labels &quot;New&quot; and &quot;Urgent,&quot; tickets with either the &quot;New&quot; or &quot;Urgent&quot; labels do not display. Enter the name of a label and select it from the list. Note: You can add more than one label to each filter option. (Optional) Save the view for all agents to use:Note: To save views, you must be an administrator or have a custom role with Create, update, and deleted views enabled in the Ticket List &amp; Saved Replies permissions. Click Save View as or click the Save View drop-down and select Save View as.Enter a name for the view and click Save View. Tip:Combine with other ticket filters to create custom views for your entire team to use. 

2 min read

Filtering Articles by Label

View articles in your Knowledge Base that have or do not have specific labels. Adding label filters allows you to organize and categorize your articles further. To filter articles by label: Click the Knowledge Base icon  in the side panel. (Optional) Click the Languages menu at the top-right and select a language.  Click the Filters icon on the left.Click + Add Filter and select Labels. Choose what you want to do:Include articles with any of the selected labelsClick the Include Any drop-down.Select labels to include articles in the results that have any of the selected labels.For example: If you select the labels &quot;New&quot; and &quot;Not Ready,&quot; articles that have either the &quot;New&quot; or &quot;Not Ready&quot; labels display.Include articles with all the selected labelsClick the Include All drop-down.Select labels to include articles in the results that have all of the selected labels. For example: If you select the labels &quot;New&quot; and &quot;Not Ready,&quot; articles that have both the &quot;New&quot; and &quot;Not Ready&quot; labels display.Exclude articles with any of the selected labelsClick the Exclude Any drop-down.Select labels to include articles in the results that do not have any of the selected labels. For example: If you select the labels &quot;New&quot; and &quot;Not Ready,&quot; articles that have either the &quot;New&quot; or &quot;Not Ready&quot; labels do not display.6.  (Optional) Select a list or card view at the top to choose how you want to view your articles. Show me moreClick the List view icon at the top to display your articles in a list. Click the Card view icon at the top to display your articles in separate cards. 7.  (Optional) Sort your articles by update date using the Newest First / Oldest First menu. Show me moreClick Newest First at the top and select Oldest First to view articles that have not been updated for the longest amount of time at the top of the list. Click Oldest First at the top and select Newest First (default) to view articles that were most recently updated at the top of the list. Tip:You can add more than one article filter to refine your search results. 

2 min read

Managing Your Labels

Create, rename, and delete labels from the Label Manager in your Answers account. Here you can also access the articles and tickets added to each label. Important:To manage labels, you must be an administrator or have a custom role with Labels enabled in the Settings - Tools permissions.To manage your labels: Hover over Settings and click Labels. Tip: Click the Search icon and enter a label name to find an existing label. Choose what you want to do: Create a new label: Click + New Label. Enter a label name and click Create. Rename a label: Hover over the relevant label and click the Show More icon . Select Rename. Edit the label name and click Save. Delete a label: Hover over the relevant label and click the Show More icon . Select Delete. Click Yes, Delete this label.  Tip:Filter articles or tickets by a specific label by hovering over the label and clicking Used in __ Articles or Used in __ Tickets. 

1 min read

About Labels

Add labels to articles and tickets for an extra layer of categorization and functionality. Use labels in your Knowledge Base to organize articles and determine where they can be viewed. Use labels with tickets and Automatic Actions to optimize your Ticketing System's workflows. Managing Your LabelsCreate, rename, and delete the labels you'll add to articles and tickets from your Label Manager. Important:To manage labels, you must be an administrator or have a custom role with Labels enabled in the Settings - Tools permissions.Show me how Hover over Settings  in the side panel and click Labels. Choose what you want to do: Create a new label: Click + New Label. Enter a label name and click Create. Rename a label: Hover over the relevant label and click the Show More icon . Select Rename. Edit the label name and click Save. Delete a label: Hover over the relevant label and click the Show More icon . Select Delete. Click Yes, Delete this label. Using Labels With ArticlesAdd labels to Knowledge Base articles for an extra layer of categorization and functionality. Categorizing articles with labelsLabels can help you group articles that have something in common, but don't fit within the same category or subcategory. After adding labels to articles, you can filter your Knowledge Base to include or exclude articles by label. For example:If you need to keep track of articles that relate to a new major feature, create a label and add it to the relevant articles. Then add the label filter to your Knowledge Base to view a list of articles that have the label. Show me howTo add the label filter to your Knowledge Base article list: Click the Knowledge Base icon  in the side panel. (Optional) Click the Languages menu at the top-right and select a language. Click the Filters icon  on the left. Click + Add Filter and select Labels.Learn more about adding label filters to your Knowledge Base. Showing and hiding articles with labelsUse labels to show or hide specific articles from your Help Center and Widgets. You can also use them to create 'internal' articles agents link for data tracking purposes.For example:You can publish and hide an unfinished article by adding a 'hidden' label to it, then excluding the label from your Help Center and Widgets. Show me howTo hide an article from your Help Center and Widgets: Create a label you'll use for hiding articles. Add the label to articles you want to hide.  Exclude the label from your Help Center and Widgets. View a full tutorial about creating internal articles. Using Labels With TicketsUse labels to keep tickets organized and apply actions to them automatically with Automatic Actions. Agents can also add labels to tickets manually. Organizing tickets with labelsKeep tickets organized by adding labels to them when they have something in common. Then make it easy for agents to work on specific types of tickets by including or excluding labels in ticket views. For example:You could add a 'legal' label to tickets that your legal department should answer. Then create a custom view that includes the label so your legal department can see all their tickets in one place. Show me howTo manually add a label to a ticket: Go to the relevant ticket.  Click + Add Label and select a label. Tip: Enter a label name to search for it. To add the label filter to a ticket view: Click the Tickets icon  in the side panel. Hover over the view you'd like to filter and click Edit. Click Add Filter and select Labels. Click the Include Any drop-down and select the label you'd like to include. (Optional) Add other filters to your view.  (Optional) Save the view for all agents to use: Note: To save views, you must be an administrator or have a custom role with Create, update, and deleted views enabled in the Ticket List &amp; Saved Replies permissions. Click Save View as or click the Save View drop-down  and select Save View as. Enter a name for the view and click Save View. Using Automatic Actions with labelsUse Automatic Actions to add labels to tickets that fit certain criteria, or perform actions on tickets that have specific labels.For example:You could create an Automatic Action that adds the 'legal' label to tickets sent to your legal department's mailbox. Then you could create an Automatic Action that assigns tickets with the 'legal' label to the group of agents in your legal department. Show me how to add labels to tickets using Automatic Actions Hover over Settings  in the side panel and click Automatic Actions. Click + Create New Action. Note: Click Start Now then click Create New Action if this is your first Automatic Action. Enter a name for the action. (Optional) Enter a description of the action. Click the toggle(s) under Apply action when to apply the action when: A new ticket is created: The action applies when a new ticket is created. A user replies: The action applies when a customer replies. Set the conditions that will cause the action to occur: ANY of these conditions occur: Set the action that occurs if ANY of the conditions are met: Click the drop-down menu and select a condition. Click the Operator drop-down menu and select an option (e.g. Is, Is Not). Note: If you selected User is authenticated or a Checkbox custom field type, click Yes or No and skip the next step. Enter the value that the condition must meet. (Optional) Click Add Another Condition to add another condition then repeat the steps. ALL of these conditions occur: Set the action that occurs only if ALL of the conditions are met: Click the drop-down menu and select a condition. Click the Operator drop-down menu and select an option (e.g. Is, Is Not). Note: If you selected User is authenticated or a Checkbox custom field type, click Yes or No and skip the next step. Enter the value that the condition must meet. (Optional) Click Add Another Condition to add another condition then repeat the steps. Click the drop-down menu under Select an action and select Set labels. Click the Select labels field and enter the label you want to add to tickets.  Click Save.Show me how to apply an Automatic Action when a ticket has a specific label Hover over Settings  in the side panel and click Automatic Actions. Click + Create New Action. Note: Click Start Now then click Create New Action if this is your first Automatic Action. Enter a name for the action. (Optional) Enter a description of the action. Click the toggle(s) under Apply action when to apply the action when: A new ticket is created: The action applies when a new ticket is created. A user replies: The action applies when a customer replies. Click the ANY of these conditions occur drop-down and select Ticket labels.  Click the Select labels drop-down and select the label that, when tickets have it, an action will occur. Scroll down to the Action to take section and click the Select an action drop-down.  Click the action you want to occur when tickets contain the label you selected in step 7.  Continue filling out the options for the action.  (Optional) Click Add Another Condition to add another condition then repeat the steps. Click Save.Tip:Learn more about working with Automatic Actions. 

7 min read