Wix Answers Developers Overview

The WIX Answers REST API enables you to use code to interact with the Wix Answers back-end. You can use the API to create webhooks that interact with the Wix Answers front and back-ends, or create a new front-end app that works with the Wix Answers back-end. You can also use the API to get information about your customers and their Wix Answers history.

The API documentation assumes that you are familiar with Wix Answers features and have read the knowledge base articles about these features.

The API documentation includes articles with the following subcategories in the Developers category:
  • API Overview: This document
  • API Reference: All public Wix Answers APIs. Start with the API Reference Overview.
  • Data Reference: Common objects and enumerations returned by APIs, as well as required permissions and roles
  • Procedures: Frequently asked workflow questions, such as how to find information you might need or how to combine APIs or webhooks to perform common procedures
  • SDK: How and where to create code that works with the APIs and back-end. Start with the Wix Answers SDK Overview.
  • Webhooks: How to create webhooks that may be called from the APIs
Note: Keep a Debug Log
We highly recommend that you create a minimum 3-day log of responses from Wix Answers. This will ease your debugging process in the case of any issues.
You can test API calls using cURL or any similar software.

Wix API methods accept HTTPS requests in JSON content-type with UTF-8 character set (application/json; charset=utf-8). Parameters are case-sensitive: for example, ID is not accepted when id is expected.

Successful responses are returned by HTTPS in JSON format (application/json) with status headers that include codes in the 200-300 range. For example:
1
2
3
4
5
6
7
8
Status: 200

{
    "id": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa",
    "name": "Article Title",
    ...
    "creationDate": 1568180889000
}

API Endpoint

All URLs referenced in the API documentation have the following endpoint: https://<tenant_subdomain>.wixanswers.com

Authorization

Some API endpoints do not require authorization. Most endpoints require a JWT authorization token generated from an API key. The token is valid for one hour and must be sent on every request using an Authorization header:

Authorization: Bearer <token>

Token Types

A user-specific authorization token has the authorization for that user or agent. This token has an intersection of the permissions of the user and the API key, and contains the user's ID. A general authorization token (not specific to a user) has all permissions of the API key and contains the user ID for "System User".

Some endpoints require a user-specific authorization token. For these endpoints, a general authorization token does not work. For example, adding a ticket as a specific user requires a user-specific token; see Add a Ticket as Authenticated User.

For all other endpoints, you can use a general token, if the API key has the required permission, or a user-specific token, if the API key + user ID has the required permission. If you use the general token, Wix Answers records the activity as done by "System User".

In some cases, such as reading articles on a public website, no authorization token is required.

API Keys, Roles, and Permissions

Wix Answers uses API keys, roles, and permissions to determine whether you are allowed to access an endpoint.

You can configure multiple API keys in Wix Answers, and you can enable or restrict sets of permissions for each API key.


In addition to restricting permissions by API keys, you can assign roles to agents. Agents are users that are assigned any role: these are your team members who have access to the Wix Answers app. Roles are collections of permissions. Wix Answers comes with three out-of-the-box roles: Viewer, Agent, and Admin. Viewers have access to read-only Wix Answers endpoints and to the Wix Answers app. Agents can do anything Viewers can do, but they also can manage users, tickets, articles, calls, and other non-administrative areas of the app. An Admin(istrator) can do anything an Agent can do, and can also manage other agents and perform other administrative tasks. An admin can define other roles in the Wix Answers App.

Since a non-agent user does not have a role, a user-specific token generated for this kind of user has no permissions, not even the ones in the API key. A user-specific token generated for an agent has an intersection of the permissions of the agent's role and the API key.  For example, if an agent has a role that includes FETCH_ARTICLES but does not include MANAGE_ARTICLES, then a token generated for this agent does not include MANAGE_ARTICLES, even if the API key does. This token cannot access any endpoints that require MANAGE_ARTICLES.

For some endpoints, no token is required. For some endpoints, any valid token is required and the endpoint does not require any specific permission. For some endpoints, a user-specific authorization token is required but the endpoint does not require any specific permission. And for some endpoints, any valid token is required but the API key and the user associated with the token (when sending a user-specific authorization token) must all have a specific permission.

To summarize, the following lists the cases in which you can access a particular endpoint:
  • The endpoint does not require you to send a token
OR
  • The endpoint requires you to send a token
  • The endpoint does not require a token with a specific permission
  • You send a valid token
OR
  • The endpoint requires you to send a user-specific token
  • You send a valid user-specific token
OR
  • The endpoint requires you to send a token
  • The endpoint requires a specific permission
  • You send a valid token
  • The permission related to the endpoint, if any, is
    • Included in the API key's list of permissions, AND
    • Included in the role assigned to the user associated with the token, if any

In a few cases, the endpoint requires you to send a user-specific token AND the endpoint requires a specific permission. In this case, the user for the token must be an agent with a role that includes the required permission and the API key must include the required permission.
Help Center Authorization Override
You can configure your help center to require users to register before they can access any contents. In this case, all API calls require an authorization token, even if no authorization is indicated in the documentation.
Tokens with no User Specified
If you request a token without specifying the user that the token is for, the token is a general token with admin privileges, but will not work for endpoints that require a token associated with a specific user.

Authenticated Users

To be an authenticated user means that Wix Answers has authenticated the user's email and the user has a unique ID (GUID).

Chat Unauthenticated User Header

When starting a chat for an authenticated user, first request an authorization token using the user's GUID. For information about this token and about chat API endpoints, contact Wix Answers customer support.

Partners

A partner is an authenticated user associated with multiple companies. Partners create and monitor tickets on behalf of customers in these companies. Partners are not agents.

Requesting an Authorization Token (Without Specifying a User)

Requesting an Authorization Token Must be Made as a Server-Side Request
You send the tenant secret in order to obtain an authorization token. This secret is extremely sensitive and must be kept private. Therefore, requests to obtain an authorization token must be made from your servers as server-side requests, NOT from a client.

The authorization token is also sensitive, since it enables its holder to act on behalf of the user that it represents. It is important to ensure that the token is kept secure (from everyone except the client/user who will use it). Therefore, Wix Answers recommends that all client requests be made to your servers, which in turn send the token as server-side requests to the Wix Answers API.
To obtain an API token without specifying a user:
  1. In the Wix Answers app, navigate to Settings > Tools > Webhooks & API Keys (https://<tenant_subdomain>.wixanswers.com/app/settings/tools/webhooks-and-api/webhooks) and copy Key ID (Public) and Secret (Private).
  2. Make a request to the token generator endpoint, with the parameters key and secret (both are required).

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

  • Content type: application/json; charset=utf-8
  • Accept: application/json
Payload Structure:
1
2
3
4
5
6
POST https://<tenant_subdomain>.wixanswers.com/api/v1/accounts/token

{
   "keyId":"<key_id>",
   "secret":"<secret>"
}
Request Example Using cURL:
1
2
3
4
5
6
curl -XPOST 'https://<tenant_subdomain>.wixanswers.com/api/v1/accounts/token' -d '{
 "keyId":"<key_id>",
 "secret":"<secret>"
}' 
-H 'Content-Type: application/json; charset=utf-8'
-H 'Accept: application/json'
Response Example:
1
2
3
{
    "token":"eyJlbmMiOiJBMTI0NNIiwiYWxnIjoiZGlyIn0..9-fRNeE8J3SspYg9.3eaSroE6kEIpLfdgmhg0fvOxMUs1YAHZC6dHacAkZOOjD1EA-1pApV863H1fxqCVoGbq2163PnE--83rFqU4RxbH33tTbfw0kE-baf1YEnbVt5MOWoQ_F59FzY.BiTX-Ao-OcaDeRuEDIuaeA"
}

Requesting a Specific User's Authorization Token

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

If you have the required permission (users with the agent or admin roles have this permission), you can get a token for a specific user. This kind of token is required where noted in the documentation. You must have the user's GUID.

  • Content type: application/json; charset=utf-8
  • Accept: application/json

Payload Structure:
1
2
3
4
5
6
7
POST https://<tenant_subdomain>.wixanswers.com/api/v1/accounts/token

{
   "keyId":"<key_id>",
   "secret":"<secret>",
   "userId":"<GUID>"
}
Request Example Using cURL:
1
2
3
4
5
6
7
curl -XPOST 'https://<tenant_subdomain>.wixanswers.com/api/v1/accounts/token' -d '{
 "keyId":"<key_id>",
 "secret":"<secret>",
 "userId":"77bc8694-5ccf-436c-ab2b-543563a5f425"
}' 
-H 'Content-Type: application/json; charset=utf-8'
-H 'Accept: application/json'
Response Example:
1
2
3
{ 
    "token":"eyJlbmMiOiJBMTI0NNIiwiYWxnIjoiZGlyIn0..9-fRNeE8J3SspYg9.3eaSroE6kEIpLfdgmhg0fvOxMUs1YAHZC6dHacAkZOOjD1EA-1pApV863H1fxqCVoGbq2163PnE--83rFqU4RxbH33tTbfw0kE-baf1YEnbVt5MOWoQ_F59FzY.BiTX-Ao-OcaDeRuEDIuaeA"
}

Requesting a Specific User's Authorization Token from a Widget

 POST https://<tenant_subdomain>.wixanswers.com/api/v1/widgets/{widget GUID}/auth

If you have the required permission (users with the agent or admin roles have this permission), you can get a token for a specific user from a widget using the user's email address. If the user is not registered as authenticated in Wix Answers, Wix Answers registers the user as authenticated before returning the token.

This is a shorter process than adding the user, receiving the user's GUID, and then requesting a token using the GUID.

  • Content type: application/json; charset=utf-8
  • Accept: application/json

Payload Structure:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
POST https://<tenant_subdomain>.wixanswers.com/api/v1/widgets/{widget GUID}/auth

{
   "email":"<email_address>",
   "keyId":"<key_id>",
   "secret":"<secret>",
   "externalId":"<external_SSO_ID>",// String. If provided, and the tenant
                                    // uses SSO, then this value is used
                                    // to identify the user, instead of
                                    // the email address.
    
// If Wix Answers registers this user as an authenticated user,
// it will add the following optional parameters to the user record.
// If the tenant uses SSO, it will also add the email address (above).
// If the user is already registered, these parameters are ignored.
    
   "firstName":"<first_name>",      // If not provided, the username
                                    // of the email address is used.
   "lastName":"<last_name>"
}
Request Example Using cURL:
1
2
3
4
5
6
7
curl -XPOST 'POST https://<tenant_subdomain>.wixanswers.com/api/v1/widgets/77bc8694-5ccf-436c-ab2b-543563a5f425/auth' -d '{
 "keyId":"<key_id>",
 "secret":"<secret>",
 "email":"user@yourdomain.com"
}' 
-H 'Content-Type: application/json; charset=utf-8'
-H 'Accept: application/json'
Response Example:
1
2
3
{ 
    "token":"eyJlbmMiOiJBMTI0NNIiwiYWxnIjoiZGlyIn0..9-fRNeE8J3SspYg9.3eaSroE6kEIpLfdgmhg0fvOxMUs1YAHZC6dHacAkZOOjD1EA-1pApV863H1fxqCVoGbq2163PnE--83rFqU4RxbH33tTbfw0kE-baf1YEnbVt5MOWoQ_F59FzY.BiTX-Ao-OcaDeRuEDIuaeA"
}

Important Information about Updating Structures Using the API

Fields in a PUT request entirely replace the fields in the Wix Answers back-end. Unless noted, you cannot append information to an existing field.

To modify the existing contents of a field:
  1. Get the structure using the relevant GET request.
  2. Extract the relevant field.
  3. Modify the field as required.
  4. PUT the modified field back to Wix Answers.

Common Elements in API Payloads / Objects

The following formats or values repeatedly appear in the requests you make to, or in the structures returned by, Wix Answers.
Note About Undocumented Parameters
Most return structures include additional parameters not documented in this guide. These parameters are irrelevant and can be safely ignored.

Global IDs (GUID)

Many records, such as users, tickets, labels, and so forth, are uniquely identified by a global ID, also known as a GUID. A GUID looks something like e932c0a3-6e9b-43cf-b3a9-90f6ee6a5b07.

Unix Time Strings

Unix time strings are integers indicating the number of seconds since Jan 1, 1970 00:00:00. For example, 1605020237. Unix time strings are commonly used to indicate the creation or last modified time of a record.

Date Strings

Date strings, such as those used in request payloads, are in the format yyyy-MM-dd'T'HH:mm:ss. For example, 2012-07-09T19:22:09.

Languages / Locales

Click here to see the list of supported languages.

Import ID

During the Wix Answers on-boarding process, Wix Answers can help you load your initial data by importing users, companies, articles, categories, tickets, and replies. These items are tagged during the import process with an import ID (importId).

You can use your own code (such as in a webhook) to filter these items based on their import ID.

API Request Rate Limit

The Wix Answers APIs have a rate limit. We reserve the right to adjust the rate limit for given endpoints so we can provide a high quality of service for all clients. If you need to make more requests than the limit, please contact us and we will try to accommodate your request.
Your use and access to the API are expressly conditioned on your compliance with the policies, restrictions, and other provisions related to the API set forth in our Terms of Use and our Privacy Policy. If we believe that you have or attempted to violate any term, condition, or the spirit of these policies or agreements, your right to access and use the API may be temporarily or permanently revoked.

Related Articles

Call Center APIs

The Wix Answers call center makes it easy to accept calls alongside your help center and ticketing system. The call center API enables you to get the lines and the queues of your call center.Also see Add a Phone Callback Ticket Request.Get Call Center LinesGET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/linesGets a list of all call center phone lines. Authorization: Requires agent authorization token and permission FETCH_CALLCENTER_SETTINGS Content type: application/json; charset=utf-8 Accept: application/json Response: List of Line objectsRequest Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/linesRequest Example Using curl:curl -X GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/lines -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json'Get Call Center QueuesGET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queuesGet a list of all call center queues. Authorization: Requires agent authorization token and permission FETCH_CALLCENTER_SETTINGS Content type: application/json; charset=utf-8 Accept: application/json Response: List of Queue objectsRequest Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queuesRequest Example Using curl:curl -X GET https://<tenant_subdomain>.wixanswers.com/api/v1/callcenter/queues -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json'

1 min read

Articles APIs

Articles are documents containing text, images, and videos that provide information to your users. Articles are categorized using categories, subcategories, and labels. There are three types of articles: (regular) articles, feature requests, and known issues. Users can follow articles and vote for feature requests. Agents can add notes and tasks to articles, such as "review", and assign them to other agents.You can use the Articles API to manage your articles (including feature requests, known issues, and videos). Categories and labels are manged by other APIs.Importing RecordsYou can contact Wix Answers to enable administrators to import articles in bulk.An article starts as a draft until you publish it. The draft and all previously published drafts are the article versions. When you publish a draft, Wix Answers marks the draft version as published, makes the version visible in the Help Center, and automatically creates a new draft.In the Wix Answers App, the option to publish the draft appears only when there is a difference between the draft and the most recently published version.NoteSee Common Elements in API Payloads / Objects, including the note about undocumented parameters.Get Article or Article InformationThese methods enable you to manipulate a single article.Get Article by IDGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}?locale={locale} Get an article by its GUID and locale. See Finding an Article ID. Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (public level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓defaultLocaleFallbackWhether to get the article associated with the default locale if no article exists for the specified locale.Boolean. Default is false.Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa?locale=enRequest Example Using curl:curl -X GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa?locale=en -H 'Content-Type: application/json; charset=utf-8' -H 'Authorization: Bearer <token>'Get Extended Article InformationGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/extended?locale={locale} Get extended information about an article by its GUID and locale, including task information, agent information, and so forth. See Finding an Article ID. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (extended level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/extended?locale=enGet Article by URIGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/uri/{URI}?locale={locale} Get an article by its URI and locale. Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (public level)Request ParamsDescriptionTypeRequiredlocaleArticle languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/uri/machines-1?locale=enGet Article PreviewGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/preview?locale={locale} Get an article with only its latest data by its GUID and locale. The data comes from the draft; the draft's data may or may not be different from the most recently published version's data. See Finding an Article ID. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/preview?locale=enGet List of Article VersionsGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/versions?locale={locale} Get a list of article versions, including the draft version and all previously published versions. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: List of ArticleVersion objects (restricted level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/versions?locale=enAdd ArticlePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles Create a new article. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓categoryId CategoryTo add an article without a category, use  00000000-0000-0000-0000-000000000000 as the category ID.If a category has subcategories, you cannot associate the article with the category, only with one of its subcategories.GUID✓typeArticle TypeInteger✓title The article titleThe default is an empty string.StringThe default is an empty string.✓content  The article content (HTML)The default is an empty string.StringThe default is an empty string.status  Article StatusIntegerThe default is 0 (Draft).Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles { "locale": "en", "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "type": 100, "status": 10, "title": "New App Article", "content": "<div>This is the article content</div>" }Request Example Using curl:curl -X POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles -H 'Authorization: Bearer <token>' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json' -d '{"locale": "en", "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "type": 100, "status": 10, "title": "New App Article", "content": "<div>This is the article content</div>"}Publish or Unpublish an ArticlePublish or unpublish a single article.Publish ArticlePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/publish Optionally update an article's title and content, and then publish the article. See Important Information about Updating Using the API. To just update the article, see Update Article Title and/or Content. Authorization: Requires agent authorization token and permission PUBLISH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level) The payload parameters are the same as those for Update Article.Request Example Using curl:curl -X POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/publish -H 'Authorization: Bearer <token>' -H 'Content-Type: application/json; charset=utf-8' -H 'Accept: application/json' -d '{ "title": "Wix Answers - Articles APIs", "content": "<div>This is the article content</div>", "locale": "en", "notify": false }Unpublish ArticlePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/unpublish Unpublish a published article. Authorization: Requires agent authorization token and permission PUBLISH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/unpublish { "locale": "en" }Delete or Restore an ArticleDelete or restore a single article.Delete ArticleDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}?locale={locale} Delete a single article. The article can be restored (see Restore Deleted Article). To delete all articles in a category or subcategory, see Delete All Articles in a Category. Authorization: Requires agent authorization token and permission DELETE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa?locale=enRestore Deleted ArticlePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/restore Restore a previously deleted article. Note that the ID of the article to restore is in the path. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/restore { "locale": "en" }Merge ArticlesPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/merge Merge this article (the article whose GUID appears in the path) into another one. This article is removed. All followers and notes move to the target article. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓targetIdThe article into which to merge this articleGUID✓updateCategoriesWhether to move the target article to be under the category of this article.Boolean. Default is false.Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/merge { "locale": "en", "targetId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa" }Update Article or Article MetadataThese methods enable you to update metadata associated with an article.Update Article Title and/or ContentPUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID} Update an article's title and content. See Important Information about Updating Using the API. Also see Publish Article. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓titleThe article titleTo not change the title, send the existing title. Otherwise, the title is changed to a blank string.StringcontentThe article content (HTML)To not change the content, send the existing content. Otherwise, the content is changed to a blank string.StringupdateUrlIf you updated the title, Wix Answers updates the article URI to match the new title. Any requests to the old URI are redirected to the new one.Set this to false to keep the old URI.BooleanDefault is true.notifyWhether to notify users who follow the article that the article was updated.BooleanDefault is false.Payload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa { "title": "Wix Answers - Articles APIs", "content": "<div>This is the article content</div>", "locale": "en", "notify": false }Update Article CategoryPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/move Move an article to a different category. Also see Move All Articles from One Category to Another. If a category has subcategories, you cannot move an article to the category, only to one of its subcategories. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequirednewCategoryIdNew categoryTo remove the category, use 00000000-0000-0000-0000-000000000000 as the category ID.GUIDPayload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/move { "newCategoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa" }Update Article TypePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/changeType Change an article type, and optionally its resolution (for the recommended way to change the resolution, see Update Article Resolution). Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredtypeNew Article TypeInteger✓resolutionNew Article ResolutionIntegerPayload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/changeType { "type": 110 }Update Article ResolutionPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/setResolution Change an article resolution. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredresolutionNew Article ResolutionInteger✓localesList of articles language to set the resolutionList of two-letter country code strings (for example: ['de','en'])At least one is requirednotifyWhether to notify article followers about the change in resolutionBooleanDefault is true.Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/setResolution { "resolution": 124, "locales": ["en"] }Update Article PhrasesPUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/phrases Change an article's phrases. These are keywords that are used for when searching for articles (see Search for Articles (Agent)). See Important Information about Updating Using the API. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level)NoteCurrently, phrases do not appear, and cannot be managed, in the Help Center or the Wix Answers App. However, if phrases are attached to articles, they are used when searching in the Help Center or using the API.Payload ParamsDescriptionTypeRequiredlocaleArticle languageTwo-letter country code string (for example: 'de')✓textValuesList of phrasesList of strings✓Payload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/phrases { "locale": "en", "textValues": ["programming", "JavaScript"] }Update Article LabelsPUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/labels Add or remove labels from an article. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Article Object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓addedLabelIdsList of labels to add to articleList of GUIDsremovedLabelIdsList of labels to remove from articleNote that if the same label appears in both the "add" and "remove" lists, it will remain in the article (labels are first removed, and then added).List of GUIDsPayload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/labels { "locale": "en", "addedLabelIds": ["bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa","bd948e62-a3fd-ee6a-4cf0-87f30ae7f3fb"], "removedLabelIds": ["bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fc"] }Manage Article's Related ArticlesThese methods enable you to update related articles associated with an article.Add Article RelationPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations Add an article relation. The related article must be published. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocale Article language for which to add the new relationsIf not sent, the related articles are added to the article in all locales.Two-letter country code string (for example: 'de')relatedIdThe published article to relate to this oneGUID✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/relations { "locale": "en", "relatedId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa" }Get an Article's Related Articles (Guest)GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations?locale={locale} Get related articles for this article. See also Get an Article's Related Articles (Agent). Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: List of Article Objects (public level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/relations?locale=enGet an Article's Related Articles (Agent)GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations/admin?locale={locale} Get related articles for this article, including task information, agent information, and so forth. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: List of Article Objects (restricted level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/relations/admin?locale=enDelete Article RelationDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations/{related article GUID} Delete an article relation. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypelocale Article language for which to remove the related articlesIf not sent, the related articles are removed from the article in all locales.Two-letter country code string (for example: 'de')Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/relations/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fbSort an Article's Related ArticlesPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/relations/sort For this article, sort list of related articles by their title, ascending. Related articles are normally sorted according to the order they were added. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocaleArticle languageTwo-letter country code string (for example: 'de')✓relatedIdsRelated articles to sortList of GUIDs✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/relations/sort { "relatedIds": ["bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa", "bd948e62-a3fd-ee6a-4cf0-87f30ae7f3fb"], "locale": "en" }Manage Article NotesThese methods enable you to update notes associated with an article.Add Article NotePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes Add article note. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Note object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓contentThe note contentString✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/notes { "locale": "en", "content": "A note." }Get Article NoteGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes/{note GUID}?locale={locale} Get article note. For information about a GUID, see GUID. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Note object (restricted level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fb?locale=enGet All Article NotesGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes Get all notes of an article. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept : application/json. Response: List of Note objects (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes?locale=enUpdate Article NotePUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes/{note GUID} Update article note. See Important Information about Updating Using the API. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓contentThe note contentString✓Payload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a { "locale": "en", "content": "A new note." }Delete Article NoteDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/notes/{note GUID}?locale={locale} Delete article note. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb?locale=enManage Article TasksThese methods enable you to update tasks associated with an article, as well notes associated with these tasks.Add Article TaskPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks Add article task. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: ContentTask object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓typeContent Task TypeInteger✓priorityContent Task PriorityInteger✓assignedGroupIdAgent group to which to assign this taskGUIDEither this or assignedUserId is required.assignedUserIdAgent to which to assign this taskGUIDEither this or assignedGroupId is required.descriptionTask descriptionStringPayload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/tasks { "locale": "en", "type": 30, "priority": 20, "assignedUserId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "description": "Please review!" }Get Article Task InformationGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID} Get information about an article task. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: ContentTask object (restricted level)Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-ee6a-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fbGet All Article TasksGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks?locale={locale} Get information about all article tasks. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Structure including ContentTask objects (restricted level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓pageThe page of results to returnIf not specified, the default is 1.IntegerpageSizeThe number of results to return on each pageIf not specified, the default is 20.IntegerRequest Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/tasks?locale=enResponse Example:{ "items": [ List of @ContentTask objects ], "itemsCount": 108, "page": 2, "numPages": 22, "previousPage": 1, "nextPage": 3, "pageSize": 5 }Get a Count of an Article's TasksGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/count Get the number of tasks attached to an article. You can filter by task status. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: IntegerRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓statusFilter by Content Task StatusIntegerAdd Article TranslationsPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/translations Add article translations and, by default, translation tasks for these translations. After creating a translation task, Wix Answer invokes the Article Sent to Translation webhook. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocalesList of required Article languagesList of two-letter country code strings (for example: ['de','en'])At least one is requiredtaskPriorityContent Task PrioritiesIntegerDefault is 20.openTranslationTasksWhether to add translation tasks for the article translationsBooleanDefault is true.noteTextNote contentsStringPayload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/translations { "locales": ["de"] }Update Article TaskPUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID} Update article task. See Important Information about Updating Using the API. To mark a task as complete / open, see Complete Article Task or Open/Reopen Article Task. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: ContentTask object (restricted level)Payload ParamsDescriptionTypeRequiredpriorityContent Task PriorityInteger✓assignedGroupIdAgent group to which to assign this taskGUIDEither this or assignedUserId is required.assignedUserIdAgent to which to assign this taskGUIDEither this or assignedGroupId is required.descriptionTask descriptionStringPayload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/tasks/d367738e-368e-41fe-9289-1a5cbbc3c239 { "priority": 20, "assignedUserId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "description": "Please review!" }Complete Article TaskPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/complete Complete an article task. This updates the status, completion date, and "completed by user" fields of the task. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: ContentTask object (restricted level) No payload is required.Open/Reopen Article TaskPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/open Open or reopen an article task. This updates the task's status. If the article was previously marked as complete, this does not change the completion date or "completed by user" fields of the task. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: ContentTask object (restricted level) No payload is required.Add Article Task NotePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/notes Add note about article task. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Note object (restricted level)Payload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')contentThe note contentString✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/tasks/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/notes { "locale": "en", "content": "I will review." }Update Article Task NotePUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/notes/{note GUID} Update note about article task. See Important Information about Updating Using the API. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓contentThe note contentString✓Payload Example:PUT https://<tenant_subdomain>.wixanswers.com/api/v1/articles/e932c0a3-6e9b-43cf-b3a9-0ae790f6ee6a/tasks/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/notes/d367738e-368e-41fe-9289-1a5cbbc3c239 { "locale": "en", "content": "I will review." }Delete Article Task NoteDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}/notes/{note GUID}?locale={locale} Delete note about article task. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-ee6a-87f30ae7f3fb/notes/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fc?locale=enDelete an Article TaskDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks/{task GUID}?locale={locale} Delete an article task. To delete multiple tasks, see Delete One or More Article Tasks. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb?locale=enDelete One or More Article TasksDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/tasks?locale={locale}&ids={task GUID},{task GUID},... Delete one or more tasks from an article. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓idsTasks to delete, separated by commasAlternately, include this param for each task to delete.List of GUIDs✓Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa/tasks/bd948e62-a3fd-4cf0-ee6a-87f30ae7f3fb?locale=en&ids=bd948e62-a3fd-4cf0-87f30ae7f3fc,bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fdManage Article Interaction (Follow, Helpful, Vote)These methods enable you to update user interaction associated with an article, including followers, votes for feature requests, and users who marked an article or video as helpful (or otherwise).Get Counters of Article InteractionsGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/counters?locale={locale} Get a list of counts of article followers, views, voters, and helpful/unhelpful indications. Authorization: Requires agent authorization token Content type: application/json; charset=utf-8. Accept: application/json. Response: List of Counter objects, one of each counter type.Request ParamsDescriptionTypelocale Article languageTwo-letter country code string (for example: 'de')Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/counters?locale=enGet Whether You Follow an ArticleGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/follow?locale={locale} Get whether you are following an article. Authorization: Requires agent authorization token for specific user Content type: application/json; charset=utf-8. Accept: application/json. Response: BooleanRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/follow?locale=enGet List of Articles You FollowGET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/followed?locale={locale} Get the list of articles that you follow. Authorization: Requires agent authorization token for specific user Content type: application/json; charset=utf-8. Accept: application/json. Response: Structure including list of Article Objects (public level)Request ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓pagePage of resultsIntegerDefault is 1.pageSizeNumber of results on each pageInteger, between 1 and 500Default is 10.Request Example:GET https://<tenant_subdomain>.wixanswers.com/api/v1/articles/followed?locale=en&page=2&pageSize=20Response Example:{ "items": [ List of @Article objects ], "itemsCount": 108, "page": 2, "numPages": 22, "previousPage": 1, "nextPage": 3, "pageSize": 5 }Follow an ArticlePOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/follow Follow an article. Authorization: Requires agent authorization token for specific user Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/follow { "locale": "en" }Unfollow an ArticleDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/follow?locale={locale} Unfollow an article. Authorization: Requires agent authorization token for specific user Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/follow?locale=enIndicate If You Find an Article or Video HelpfulPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/helpful Mark or clear an article or video as helpful or not helpful. Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓newStateNew helpful indication:* Not helpful (-1)* No indication (0)* Helpful (1)-1, 0, or 1✓statePrevious helpful indication:* Not helpful (-1)* No indication (0)* Helpful (1)-1, 0, 1Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/helpful { "locale": "en", "newState": 1 }Vote for a Feature RequestPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/vote Vote for a feature request article. If you have already voted for this request, this has no effect. Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/d367738e-368e-41fe-9289-1a5cbbc3c239/vote { "locale": "en" }Clear Your Vote from a Feature RequestDELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/{article GUID}/vote?locale={locale} Clear your vote from a feature request article. If you have not already voted for this request, this has no effect. Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: NoneRequest ParamsDescriptionTypeRequiredlocale Article languageTwo-letter country code string (for example: 'de')✓Request Example:DELETE https://<tenant_subdomain>.wixanswers.com/api/v1/articles/bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa/vote?locale=enManage Multiple ArticlesThese methods enable you to work with articles in bulk.Search for Articles (Agent)POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/search/adminGet list of articles matching search / filter criteria.Note:The search include drafts and deleted articles.  The returned articles include extended information, including associated labels. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Structure including list of Article Objects (extended level)Payload ParamsDescriptionTypeRequiredidsSearch for specific articlesList of GUIDsexcludedIdsFilter by excluding specific articlesList of GUIDspermalinkSearch for article at specific URIStringlocaleArticle languageTwo-letter country code string (for example: 'de')✓statusesFilter by list of Article StatusesDraft (0) is the default.List of integersresolutionsFilter by list of Article ResolutionsList of integershandledByuserIdsFilter by list of agents that have handled (created or edited) the article.List of GUIDshandledByMeFilter by articles that you have handledBooleantypesFilter by list of Article TypesList of integerscategoryIdsFilter by list of included categories/subcategoriesList of GUIDsexcludedCategoryIdsFilter by list of excluded categories/subcategoriesList of GUIDssearchParentCategoriesWhether to also include / exclude parent categories for the categories listed in categoryIds / excludedCategoryIdsBooleanDefault is true.textFor a text search (sortType=100), filter by best match for exact text in the article title, content (see searchContent.), or phrasesStringMax 200 characters.mustMatchTextFor a text search (sortType=100), filter by exact text that must appear in the article title, content, or phrases.StringmustNotMatchTextFor a text search (sortType=100), filter by exact text that must not appear in the article title, content, or phrases.StringsearchContentWhether to also apply a text search (text, mustMatchText, mustNotMatchText) to the article content (and not only the title or phrases)BooleanDefault is true.spellcheckWhether to correct the spelling in the text search string and try the search again if searching with the uncorrected search string yielded no results.BooleanDefault is true.analyzeTextWhen true, then if text is not empty, and mustMatchText and mustNotMatchText are empty, then parse the text search string, as follows:- Words that starts with a dash "-" are added to a "must not match" list.- Words that starts with a dash "+" are added to a "must match" list.- All other words are used to search as regular text.When false, the text field is used to search as regular text.BooleanDefault is true.multilingualFilter by whether the article is multilingual (has multiple versions for different languages)BooleantaskTypeFilter by list of Content Task Types associated with the articleList of integerstaskStatusesFilter by list of Content Task Statuses associated with the articleList of integerstaskPrioritiesFilter by list of Content Task Priorities of tasks associated with the articleList of integerstaskCreatedByUserIdsFilter by list of agents who created tasks associated with the articleList of GUIDstaskAssignedUsedIdsFilter by list of agents assigned to tasks associated with the articleList of GUIDstaskAssignedGroupIdsFilter by list of agent groups assigned to tasks associated with the articleList of GUIDstaskExcludedAssignedUserIdsFilter by list of agents not assigned to tasks associated with the articleList of GUIDstaskCompletedByUserIdsfilter by list of agents who completed tasks associated with the articleList of GUIDsunassignedTasksWhether to return only articles with unassigned tasksfalse means don't consider whether or not there are unassigned tasks associated with the article.BooleanDefault is false.summarizeLimit the returned article content to 200 characters, each.BooleanDefault is false.hasAllOfLabelIds Filter by articles that include all of a list of included labelsList of GUIDshasAnyOfLabelIdsFilter by articles that include any of a list of included labelsList of GUIDsnotHasAnyOfLabelIdsFilter by articles that do not include any of a list of included labelsList of GUIDsfromCreationDateFilter by articles first created after this timeUnix time stringtoCreationDateFilter by articles first created before this timeUnix time stringfromLastUpdateDateFilter by articles last updated after this timeUnix time stringtoLastUpdateDateFilter by articles last updated before this timeUnix time stringfromFirstPublishDateFilter by articles first published after this time.Unix time stringtoFirstPublishDateFilter by articles first published before this time.Unix time stringfromLastPublishDateFilter by articles last published after this time.Unix time stringtoLastPublishDateFilter by articles last published before this time.Unix time stringpageThe page of results to getInteger, 1 or greaterDefault is 1.pageSizeThe number of results on each pageInteger. between 1 and 500Default is 10.sortTypeSort type. Possible values:* Creation date, ascending (10)* Creation date, descending (20)* Last updated date, ascending (30)* Last updated date, descending (40)* Position (50): The article's current sort order* Related tickets count, ascending (60)* Related tickets count, descending (70)* Best match (text search) (100). When using this sort type, enter a text string in text.* First published date, ascending (110)* First published date, descending (120)* Last published date, ascending (130)* Last published date, descending (140)* Content last updated, ascending (150)* Content last updated, descending (160)IntegerPayload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/search/admin { "text": "search article", "locale": "en", "spellcheck": true, "page": 1, "pageSize": 5, "sortType": 100 }Response Example:{ "items": [ List of @Article objects ], "itemsCount": 108, "page": 2, "numPages": 22, "previousPage": 1, "nextPage": 3, "pageSize": 5 }Search for Articles (User)POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/search Get list of articles matching search / filter criteria. Any content scope settings defined for the Help Center are merged with the search criteria sent in the request. Authorization: None Content type: application/json; charset=utf-8. Accept: application/json. Response: Structure including list of Article Objects (public level) The payload params and return structure are the same as those for the agent search; see Search for Articles (Agent).Search for Articles by TicketPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/ticketsRelatedSearch Get list of articles associated to a list of tickets. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Structure including list of Article Objects (restricted level) The payload and return structure is the same as for the regular agent search; see Search for Articles (Agent).Get the Number of Articles in a CategoryPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/category/count/admin Get the number of articles in a category. If the category has subcategories, this gets the number of articles in all of its subcategories. Includes draft-only articles (articles with no published versions), but does not include deleted articles. Authorization: Requires agent authorization token and permission FETCH_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Result structure, see belowPayload ParamsDescriptionTypeRequiredlocaleArticle languageTwo-letter country code string (for example: 'de')✓categoryIdCategoryGUID✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/category/count/admin { "locale": "en", "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa" }Response Example:Map of category IDs to category article count structure, for example:{ {"bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa", {"draftCount": 1, "publishedCount": 24} }, {"bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb", {"draftCount": 0, "publishedCount": 5} } }Move All Articles from One Category to AnotherPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/move Move all articles from one category to another category. To move only one article, see Update Article Category. If a category has subcategories, you cannot associate articles with the category, only with one of its  subcategories. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredcategoryIdCurrent categoryGUID✓newCategoryIdNew categoryTo remove the category, use  00000000-0000-0000-0000-000000000000 as the new category ID.GUID✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/move { "categoryId": "bd948e62-ee6a-a3fd-4cf0-87f30ae7f3fa", "newCategoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fb" }Sort Articles in a CategoryPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/sort Sort all articles in a category according to the specified order. Before this is run, articles are sorted according to the order they were added. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: NonePayload ParamsDescriptionTypeRequiredlocaleArticle languageTwo-letter country code string (for example: 'de')✓categoryIdCategory to sortGUID✓idList of articles in the desired sort orderIf you include any articles that are not associated with the category, the operation fails. If you do not include one or more articles that are are associated with the category, the ones that you include are sorted in the specified order and appear before the other (not included) articles.List of GUIDs✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/sort { "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa", "locale": "en" }Delete All Articles in a CategoryPOST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/deleteByCategory Delete all articles in a category. If the category has subcategories, the operation fails. To delete one article, see Delete Article. To restore an article, see Restore Deleted Article. Authorization: Requires agent authorization token and permission CREATE_ARTICLES Content type: application/json; charset=utf-8. Accept: application/json. Response: Result structure, see belowPayload ParamsDescriptionTypeRequiredcategoryIdCategoryGUID✓Payload Example:POST https://<tenant_subdomain>.wixanswers.com/api/v1/articles/deleteByCategory { "categoryId": "bd948e62-a3fd-4cf0-87f3-ee6a0ae7f3fa" }Response Example:Response ParamsDescriptionTypesuccessCountThe number of articles deletedIntegerfailCountThe number of articles that could not be deletedInteger{ "successCount": 12, "failCount": 0 }

24 min read